prawn 1.0.0.rc1 → 1.0.0.rc2

data/manual/images/vertical.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+#
+# To set the vertical position of an image use the <code>:vposition</code>
+# option.
+#
+# It may be <code>:top</code>, <code>:center</code>, <code>:bottom</code> or a
+# number representing the y-offset from the top boundary.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Example.generate(filename) do
+  bounding_box([0, cursor], :width => 500, :height => 450) do
+    stroke_bounds
+    
+    [:top, :center, :bottom].each do |vposition|
+      text "Image vertically aligned to the #{vposition}.", :valign => vposition
+      image "#{Prawn::DATADIR}/images/stef.jpg", :position  => 250,
+                                                 :vposition => vposition
+    end
+    
+    text_box "The next image has a 100 point offset from the top boundary",
+             :at => [bounds.width - 110, bounds.top - 10], :width => 100
+    image "#{Prawn::DATADIR}/images/stef.jpg", :position  => :right,
+                                               :vposition => 100
+  end
+end

data/manual/images/width_and_height.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+#
+# The image size can be set with the <code>:width</code> and
+# <code>:height</code> options.
+#
+# If only one of those is provided, the image will be scaled proportionally.
+# When both are provided, the image will be stretched to fit the dimensions
+# without maintaining the aspect ratio.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Example.generate(filename) do
+  text  "Scale by setting only the width"
+  image "#{Prawn::DATADIR}/images/pigs.jpg", :width => 150
+  move_down 20
+  
+  text  "Scale by setting only the height"
+  image "#{Prawn::DATADIR}/images/pigs.jpg", :height => 100
+  move_down 20
+  
+  text  "Stretch to fit the width and height provided"
+  image "#{Prawn::DATADIR}/images/pigs.jpg", :width => 500, :height => 100
+end

data/manual/layout/boxes.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+#
+# After defined the grid is there but nothing happens. To start taking effect
+# we need to use the grid boxes.
+#
+# <code>grid</code> has three different return values based on the arguments
+# received. With no arguments it will return the grid itself. With integers it
+# will return the grid box at those indices. With two arrays it will return a
+# multi-box spanning the region of the two grid boxes at the arrays indices.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Example.generate(filename) do
+  # The grid only need to be defined once, but since all the examples should be
+  # able to run alone we are repeating it on every example
+  define_grid(:columns => 5, :rows => 8, :gutter => 10)
+  
+  grid(4,0).show
+  grid(5,1).show
+  
+  grid([6,2], [7,3]).show
+  
+  grid([4,4], [7,4]).show
+  grid([7,0], [7,1]).show
+end

data/manual/layout/content.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+#
+# Now that we know how to access the boxes we might as well add some content
+# to them.
+#
+# This can be done by taping into the bounding box for a given grid box or
+# multi-box with the <code>bounding_box</code> method.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Example.generate(filename) do
+  # The grid only need to be defined once, but since all the examples should be
+  # able to run alone we are repeating it on every example
+  define_grid(:columns => 5, :rows => 8, :gutter => 10)
+  
+  grid([5,0], [7,1]).bounding_box do
+    text "Adding some content to this multi_box.\n" + " _ " * 200
+  end
+  
+  grid(6,3).bounding_box do
+    text "Just a little snippet here.\n" + " _ " * 10
+  end
+end

data/manual/layout/layout.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+#
+# Examples for using grid layouts.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+Prawn::Example.generate("layout.pdf", :page_size => "FOLIO") do
+  
+  package "layout" do |p|
+    
+    p.example "simple_grid"
+    p.example "boxes"
+    p.example "content"
+    
+    p.intro do
+      prose("Prawn has support for two-dimensional grid based layouts out of the box.
+
+      The examples show:")
+
+      list( "How to define the document grid",
+            "How to configure the grid rows and columns gutters",
+            "How to create boxes according to the grid"
+          )
+    end
+    
+  end
+end

data/manual/layout/simple_grid.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+#
+# The document grid on Prawn is just a table-like structure with a defined
+# number of rows and columns. There are some helpers to create boxes of content
+# based on the grid coordinates.
+#
+# <code>define_grid</code> accepts the following options which are pretty much
+# self-explanatory: <code>:rows</code>, <code>:columns</code>,
+# <code>:gutter</code>, <code>:row_gutter</code>, <code>:column_gutter</code>
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Example.generate(filename) do
+  # The grid only need to be defined once, but since all the examples should be
+  # able to run alone we are repeating it on every example
+  define_grid(:columns => 5, :rows => 8, :gutter => 10)
+  text "We defined the grid, roll over to the next page to see its outline"
+  
+  start_new_page
+  grid.show_all
+end

data/manual/manual/cover.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+#
+# Prawn manual how to read this manual page. 
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Example.generate(filename) do
+  move_down 200
+
+  image "#{Prawn::DATADIR}/images/prawn.png",
+        :scale => 0.9,
+        :at => [10, cursor]
+        
+  formatted_text_box([ {:text => "Prawn\n",
+                        :styles => [:bold],
+                        :size => 100}
+                     ], :at => [170, cursor - 50])
+
+  formatted_text_box([ {:text => "by example",
+                        :font => 'Courier',
+                        :size => 60}
+                     ], :at => [170, cursor - 160])
+  
+end

data/manual/manual/foreword.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+#
+# Prawn manual foreword page. 
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Example.generate(filename) do
+  header("Foreword, by Gregory Brown")
+  prose "This will be written just before 1.0, to give the" +
+        " core team something to look forward to."
+  end

data/manual/manual/how_to_read_this_manual.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+#
+# Prawn manual how to read this manual page. 
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Example.generate(filename) do
+  header("How to read this manual")
+  
+  prose <<-END_TEXT
+  This manual is a collection of examples categorized by theme and organized from the least to the most complex. While it covers most of the common use cases it is not a comprehensive guide.
+  
+  The best way to read it depends on your previous knowledge of Prawn and what you need to accomplish.
+  
+  If you are beginning with Prawn the first chapter will teach you the most basic concepts and how to create pdf documents. For an overview of the other features each chapter beyond the first either has a Basics section (which offer enough insight on the feature without showing all the advanced stuff you might never use) or is simple enough with only a few examples.
+  
+  Once you understand the basics you might want to come back to this manual looking for examples that accomplish tasks you need.
+  
+  Advanced users are encouraged to go beyond this manual and read the source code directly if any doubt is not directly covered on this manual.
+  END_TEXT
+  
+  move_down(BOX_MARGIN)
+  header("Reading the examples")
+  
+  prose <<-END_TEXT
+  The title of each example is the relative path from the Prawn source manual/ folder.
+  
+  The first body of text is the introductory text for the example. Generaly it is a short description of the features illustrated by the example.
+  
+  Next comes the example source code block in fixed width font.
+  
+  Most of the example snippets illustrate features that alter the page in place. The effect of these snippets is shown right below a dashed line. If it doesn't make sense to evaluate the snippet inline, a box with the link for the example file is shown instead.
+
+  Note that the <code>stroke_axis</code> method, used occasionally in the manual, is not part of standard Prawn and is used for demonstrative purposes. It is defined in this file:
+  
+  https://github.com/prawnpdf/prawn/blob/master/manual/example_helper.rb
+  END_TEXT
+
+end

data/manual/manual/manual.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+#
+# Generates the Prawn by example manual.
+#
+
+Encoding.default_external = "UTF-8" if defined? Encoding
+
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+Prawn::Example.generate("manual.pdf",
+                        :optimize_objects => true,
+                        :compress => false,
+                        :skip_page_creation => true,
+                        :page_size => "FOLIO") do
+
+  load_page "cover"
+  load_page "foreword"
+  load_page "how_to_read_this_manual"
+
+  # Core chapters
+  load_package "basic_concepts"
+  load_package "graphics"
+  load_package "text"
+  load_package "bounding_box"
+
+  # Remaining chapters
+  load_package "layout"
+  load_package "images"
+  load_package "table"
+  load_package "document_and_page_options"
+  load_package "outline"
+  load_package "repeatable_content"
+  load_package "templates"
+  load_package "security"
+end

data/manual/outline/add_subsection_to.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+#
+# We have already seen how to define an outline tree sequentially.
+#
+# If you'd like to add nodes to the middle of an outline tree the
+# <code>add_subsection_to</code> may help you.
+#
+# It allows you to insert sections to the outline tree at any point. Just
+# provide the <code>title</code> of the parent section, the
+# <code>position</code> you want the new subsection to be inserted
+# <code>:first</code> or <code>:last</code> (defaults to <code>:last</code>)
+# and a block to declare the subsection.
+#
+# The <code>add_subsection_to</code> block doesn't necessarily create new
+# sections, it may also create new pages.
+#
+# If the parent title provided is the title of a page. The page will be
+# converted into a section to receive the subsection created.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Example.generate(filename) do
+  # First we create 10 pages and some default outline
+  (1..10).each do |index|
+    text "Page #{index}"
+    start_new_page
+  end
+  
+  outline.define do
+    section("Section 1", :destination => 1) do 
+      page :title => "Page 2", :destination => 2
+      page :title => "Page 3", :destination => 3
+    end
+  end
+  
+  # Now we will start adding nodes to the previous outline
+  outline.add_subsection_to("Section 1", :first) do
+    outline.section("Added later - first position") do
+      outline.page :title => "Page 4", :destination => 4
+      outline.page :title => "Page 5", :destination => 5
+    end
+  end
+  
+  outline.add_subsection_to("Section 1") do
+    outline.page :title => "Added later - last position",
+                 :destination => 6
+  end
+  
+  outline.add_subsection_to("Added later - first position") do
+    outline.page :title => "Another page added later",
+                 :destination => 7
+  end
+  
+  # The title provided is for a page which will be converted into a section
+  outline.add_subsection_to("Page 3") do
+    outline.page :title => "Last page added",
+                 :destination => 8
+  end
+end

data/manual/outline/insert_section_after.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+#
+# Another way to insert nodes into an existing outline is the
+# <code>insert_section_after</code> method.
+#
+# It accepts the title of the node that the new section will go after and a
+# block declaring the new section.
+#
+# As is the case with <code>add_subsection_to</code> the section added
+# doesn't need to be a section, it may be just a page.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Example.generate(filename) do
+  # First we create 10 pages and some default outline
+  (1..10).each do |index|
+    text "Page #{index}"
+    start_new_page
+  end
+  
+  outline.define do
+    section("Section 1", :destination => 1) do 
+      page :title => "Page 2", :destination => 2
+      page :title => "Page 3", :destination => 3
+    end
+  end
+  
+  # Now we will start adding nodes to the previous outline
+  outline.insert_section_after("Page 2") do
+    outline.section("Section after Page 2") do
+      outline.page :title => "Page 4", :destination => 4
+    end
+  end
+
+  outline.insert_section_after("Section 1") do
+    outline.section("Section after Section 1") do
+      outline.page :title => "Page 5", :destination => 5
+    end
+  end
+  
+  # Adding just a page
+  outline.insert_section_after("Page 3") do
+    outline.page :title => "Page after Page 3", :destination => 6
+  end
+end

data/manual/outline/outline.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+#
+# Examples for defining the document outline.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+Prawn::Example.generate("outline.pdf", :page_size => "FOLIO") do
+  
+  package "outline" do |p|
+    
+    p.section "Basics" do |s|
+      s.example "sections_and_pages", :eval_source => false
+    end
+    
+    p.section "Adding nodes later" do |s|
+      s.example "add_subsection_to",    :eval_source => false
+      s.example "insert_section_after", :eval_source => false
+    end
+    
+    p.intro do
+      prose("The outline of a PDF document is the table of contents tab you see to the right or left of your PDF viewer.
+
+      The examples include:")
+
+      list( "How to define sections and pages",
+            "How to insert sections and/or pages to a previously defined outline structure"
+          )
+    end
+    
+  end
+end

data/manual/outline/sections_and_pages.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+#
+# The document outline tree is the set of links used to navigate through the
+# various document sections and pages.
+#
+# To define the document outline we first use the <code>outline</code>
+# method to lazily instantiate an outline object. Then we use the
+# <code>define</code> method with a block to start the outline tree.
+#
+# The basic methods for creating outline nodes are <code>section</code> and
+# <code>page</code>. The only difference between the two is that
+# <code>page</code> doesn't accept a block and will only create leaf nodes
+# while <code>section</code> accepts a block to create nested nodes.
+#
+# <code>section</code> accepts the title of the section and two options:
+# <code>:destination</code> - a page number to link and <code>:closed</code> -
+# a boolean value that defines if the nested outline nodes are shown when the
+# document is open (defaults to true).
+#
+# <code>page</code> is very similar to section. It requires a
+# <code>:title</code> option to be set and accepts a <code>:destination</code>.
+#
+# <code>section</code> and <code>page</code> may also be used without the
+# <code>define</code> method but they will need to instantiate the
+# <code>outline</code> object every time.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Example.generate(filename) do
+  # First we create 10 pages just to have something to link to
+  (1..10).each do |index|
+    text "Page #{index}"
+    start_new_page
+  end
+  
+  outline.define do
+    section("Section 1", :destination => 1) do 
+      page :title => "Page 2", :destination => 2
+      page :title => "Page 3", :destination => 3
+    end
+    
+    section("Section 2", :destination => 4) do
+      page :title => "Page 5", :destination => 5
+      
+      section("Subsection 2.1", :destination => 6, :closed => true) do
+        page :title => "Page 7", :destination => 7
+      end
+    end
+  end
+  
+  # Outside of the define block
+  outline.section("Section 3", :destination => 8) do
+    outline.page :title => "Page 9", :destination => 9
+  end
+  
+  outline.page :title => "Page 10", :destination => 10
+  
+  # Section and Pages without links. While a section without a link may be
+  # useful to group some pages, a page without a link is useless
+  outline.update do  # update is an alias to define
+    section("Section without link") do 
+      page :title => "Page without link"
+    end
+  end
+end