prawn-git 2.0.1

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::ManualBuilder::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::ManualBuilder::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::ManualBuilder::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/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::ManualBuilder::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::ManualBuilder::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::ManualBuilder::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::ManualBuilder::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

data/manual/repeatable_content/alternate_page_numbering.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+#
+# Below is the code to generate page numbers that alternate being rendered
+# on the right and left side of the page. The first page will have a "1" in
+# the bottom right corner. The second page will have a "2" in the bottom
+# left corner of the page. The third a "3" in the bottom right, etc.
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::ManualBuilder::Example.generate(filename) do
+  text "This is the first page!"
+
+  10.times do
+    start_new_page
+    text "Here comes yet another page."
+  end
+
+  string = "<page>"
+  odd_options = { :at => [bounds.right - 150, 0],
+                  :width => 150,
+                  :align => :right,
+                  :page_filter => :odd,
+                  :start_count_at => 1 }
+  even_options = { :at => [0, bounds.left],
+                   :width => 150,
+                   :align => :left,
+                   :page_filter => :even,
+                   :start_count_at => 2 }
+  number_pages string, odd_options
+  number_pages string, even_options
+end

data/manual/repeatable_content/page_numbering.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+#
+# The <code>number_pages</code> method is a simple way to number the pages of
+# your document. It should be called towards the end of the document since
+# pages created after the call won't be numbered.
+#
+# It accepts a string and a hash of options:
+#
+# <code>start_count_at</code> is the value from which to start numbering pages
+#
+# <code>total_pages</code> If provided, will replace <code>total</code> with
+# the value given.  Useful for overriding the total number of pages when using
+# the start_count_at option.
+#
+# <code>page_filter</code>, which is one of: <code>:all</code>,
+# <code>:odd</code>, <code>:even</code>, an array, a range, or a Proc that
+# receives the page number as an argument and should return true if the page
+# number should be printed on that page.
+#
+# <code>color</code> which accepts the same values as <code>fill_color</code>
+#
+# As well as any option accepted by <code>text_box</code>
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::ManualBuilder::Example.generate(filename) do
+  text "This is the first page!"
+
+  10.times do
+    start_new_page
+    text "Here comes yet another page."
+  end
+
+  string = "page <page> of <total>"
+  # Green page numbers 1 to 7
+  options = { :at => [bounds.right - 150, 0],
+              :width => 150,
+              :align => :right,
+              :page_filter => (1..7),
+              :start_count_at => 1,
+              :color => "007700" }
+  number_pages string, options
+
+  # Gray page numbers from 8 on up
+  options[:page_filter]    = lambda{ |pg| pg > 7}
+  options[:start_count_at] = 8
+  options[:color]          = "333333"
+  number_pages string, options
+
+  start_new_page
+  text "See. This page isn't numbered and doesn't count towards the total."
+end

data/manual/repeatable_content/repeatable_content.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+#
+# Examples for stamps and repeaters.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+Prawn::ManualBuilder::Example.generate("repeatable_content.pdf", :page_size => "FOLIO") do
+
+  package "repeatable_content" do |p|
+
+    p.example "repeater",       :eval_source => false
+    p.example "stamp"
+    p.example "page_numbering", :eval_source => false
+    p.example "alternate_page_numbering", :eval_source => false
+
+    p.intro do
+      prose("Prawn offers two ways to handle repeatable content blocks. Repeater is useful for content that gets repeated at well defined intervals while Stamp is more appropriate if you need better control of when to repeat it.
+
+      There is also one very specific helper for numbering pages.
+
+      The examples show:")
+
+      list( "How to repeat content on several pages with a single invocation",
+            "How to create a new Stamp",
+            'How to "stamp" the content block on the page',
+            "How to number the document pages with one simple call"
+          )
+    end
+
+  end
+end

data/manual/repeatable_content/repeater.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+#
+# The <code>repeat</code> method is quite versatile when it comes to define
+# the intervals at which the content block should repeat.
+#
+# The interval may be a symbol (<code>:all</code>, <code>:odd</code>,
+# <code>:even</code>), an array listing the pages, a range or a
+# <code>Proc</code> that receives the page number as an argument and should
+# return true if the content is to be repeated on the given page.
+#
+# You may also pass an option <code>:dynamic</code> to reevaluate the code block
+# on every call which is useful when the content changes based on the page
+# number.
+#
+# It is also important to say that no matter where you define the repeater it
+# will be applied to all matching pages.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::ManualBuilder::Example.generate(filename) do
+  repeat(:all) do
+    draw_text "All pages", :at => bounds.top_left
+  end
+
+  repeat(:odd) do
+    draw_text "Only odd pages", :at => [0,0]
+  end
+
+  repeat(:even) do
+    draw_text "Only even pages", :at => [0,0]
+  end
+
+  repeat([1,3,7]) do
+    draw_text "Only on pages 1, 3 and 7", :at => [100,0]
+  end
+
+  repeat(2..4) do
+    draw_text "From the 2nd to the 4th page", :at => [300,0]
+  end
+
+  repeat(lambda { |pg| pg % 3 == 0 }) do
+    draw_text "Every third page", :at => [250, 20]
+  end
+
+  repeat(:all, :dynamic => true) do
+    draw_text page_number, :at => [500, 0]
+  end
+
+  10.times do
+    start_new_page
+    draw_text "A wonderful page", :at => [400,400]
+  end
+end