prawn-git 2.0.1

data/manual/basic_concepts/adding_pages.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+#
+# A PDF document is a collection of pages. When we create a new document be it
+# with <code>Document.new</code> or on a <code>Document.generate</code> block
+# one initial page is created for us.
+#
+# Some methods might create new pages automatically like <code>text</code> which
+# will create a new page whenever the text string cannot fit on the current
+# page.
+#
+# But what if you want to go to the next page by yourself? That is easy.
+#
+# Just use the <code>start_new_page</code> method and a shiny new page will be
+# created for you just like in the following snippet.
+#
+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 "We are still on the initial page for this example. Now I'll ask " +
+       "Prawn to gently start a new page. Please follow me to the next page."
+
+  start_new_page
+
+  text "See. We've left the previous page behind."
+end

data/manual/basic_concepts/basic_concepts.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+#
+# Examples for Prawn basic concepts.
+#
+
+require_relative "../example_helper"
+
+Prawn::ManualBuilder::Example.generate("basic_concepts.pdf", :page_size => "FOLIO") do
+
+  package "basic_concepts" do |p|
+
+    p.example "creation", :eval_source => false, :full_source => true
+    p.example "origin"
+    p.example "cursor"
+    p.example "other_cursor_helpers"
+    p.example "adding_pages"
+    p.example "measurement"
+    p.example "view", :eval_source => false, :full_source => true
+
+    p.intro do
+      prose("This chapter covers the minimum amount of functionality you'll need to start using Prawn.
+
+      If you are new to Prawn this is the first chapter to read. Once you are comfortable with the concepts shown here you might want to check the Basics section of the Graphics, Bounding Box and Text sections.
+
+      The examples show:")
+
+      list( "How to create new pdf documents in every possible way",
+            "Where the origin for the document coordinates is. What are Bounding Boxes and how they interact with the origin",
+            "How the cursor behaves",
+            "How to start new pages",
+            "What the base unit for measurement and coordinates is and how to use other convenient measures",
+            "How to build custom view objects that use Prawn's DSL"
+          )
+    end
+  end
+end

data/manual/basic_concepts/creation.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+#
+# There are three ways to create a PDF Document in Prawn: creating a new
+# <code>Prawn::Document</code> instance, or using the
+# <code>Prawn::Document.generate</code> method with and without block arguments.
+#
+# The following snippet showcase each way by creating a simple document with
+# some text drawn.
+#
+# When we instantiate the <code>Prawn::Document</code> object the actual pdf
+# document will only be created after we call <code>render_file</code>.
+#
+# The generate method will render the actual pdf object after exiting the block.
+# When we use it without a block argument the provided block is evaluated in the
+# context of a newly created <code>Prawn::Document</code> instance. When we use
+# it with a block argument a <code>Prawn::Document</code> instance is created
+# and passed to the block.
+#
+# The generate method without block arguments requires
+# less typing and defines and renders the pdf document in one shot.
+# Almost all of the examples are coded this way.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+# Assignment
+pdf = Prawn::Document.new
+pdf.text "Hello World"
+pdf.render_file "assignment.pdf"
+
+# Implicit Block
+Prawn::Document.generate("implicit.pdf") do
+  text "Hello World"
+end
+
+# Explicit Block
+Prawn::Document.generate("explicit.pdf") do |pdf|
+  pdf.text "Hello World"
+end

data/manual/basic_concepts/cursor.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+#
+# We normally write our documents from top to bottom and it is no different with
+# Prawn. Even if the origin is on the bottom left corner we still fill the page
+# from the top to the bottom. In other words the cursor for inserting content
+# starts on the top of the page.
+#
+# Most of the functions that insert content on the page will start at the
+# current cursor position and proceed to the bottom of the page.
+#
+# The following snippet shows how the cursor behaves when we add some text to
+# the page and demonstrates some of the helpers to manage the cursor position.
+# The <code>cursor</code> method returns the current cursor position.
+#
+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
+  stroke_axis
+
+  text "the cursor is here: #{cursor}"
+  text "now it is here: #{cursor}"
+
+  move_down 200
+  text "on the first move the cursor went down to: #{cursor}"
+
+  move_up 100
+  text "on the second move the cursor went up to: #{cursor}"
+
+  move_cursor_to 50
+  text "on the last move the cursor went directly to: #{cursor}"
+end

data/manual/basic_concepts/measurement.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+#
+# The base unit in Prawn is the PDF Point. One PDF Point is equal to 1/72 of
+# an inch.
+#
+# There is no need to waste time converting this measure. Prawn provides
+# helpers for converting from other measurements
+# to PDF Points.
+#
+# Just <code>require "prawn/measurement_extensions"</code> and it will mix some
+# helpers onto <code>Numeric</code> for converting common measurement units to
+# PDF Points.
+#
+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
+  require "prawn/measurement_extensions"
+
+  [:mm, :cm, :dm, :m, :in, :yd, :ft].each do |measurement|
+    text "1 #{measurement} in PDF Points: #{1.send(measurement)} pt"
+    move_down 5.mm
+  end
+end

data/manual/basic_concepts/origin.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+#
+# This is the most important concept you need to learn about Prawn:
+#
+# PDF documents have the origin <code>[0,0]</code> at the bottom-left corner of
+# the page.
+#
+# A bounding box is a structure which provides boundaries for inserting content.
+# A bounding box also has the property of relocating the origin to its relative
+# bottom-left corner. However, be aware that the location specified when
+# creating a bounding box is its top-left corner, not bottom-left (hence the
+# <code>[100, 300]</code> coordinates below).
+#
+# Even if you never create a bounding box explictly, each document already comes
+# with one called the margin box. This initial bounding box is the one
+# responsible for the document margins.
+#
+# So practically speaking the origin of a page on a default generated document
+# isn't the absolute bottom left corner but the bottom left corner of the margin
+# box.
+#
+# The following snippet strokes a circle on the margin box origin. Then strokes
+# the boundaries of a bounding box and a circle on its origin.
+#
+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
+  stroke_axis
+
+  stroke_circle [0, 0], 10
+
+  bounding_box([100, 300], :width => 300, :height => 200) do
+    stroke_bounds
+    stroke_circle [0, 0], 10
+  end
+end

data/manual/basic_concepts/other_cursor_helpers.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+#
+# Another group of helpers for changing the cursor position are the pad methods.
+# They accept a numeric value and a block. <code>pad</code> will use the numeric
+# value to move the cursor down both before and after the block content.
+# <code>pad_top</code> will only move the cursor before the block while
+# <code>pad_bottom</code> will only move after.
+#
+# <code>float</code> is a method for not changing the cursor. Pass it a block
+# and the cursor will remain on the same place when the block returns.
+#
+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
+  stroke_horizontal_rule
+  pad(20) { text "Text padded both before and after." }
+
+  stroke_horizontal_rule
+  pad_top(20) { text "Text padded on the top." }
+
+  stroke_horizontal_rule
+  pad_bottom(20) { text "Text padded on the bottom." }
+
+  stroke_horizontal_rule
+  move_down 30
+
+  text "Text written before the float block."
+
+  float do
+    move_down 30
+    bounding_box([0, cursor], :width => 200) do
+      text "Text written inside the float block."
+      stroke_bounds
+    end
+  end
+
+  text "Text written after the float block."
+end

data/manual/basic_concepts/view.rb

@@ -0,0 +1,42 @@
+# encoding: UTF-8
+#
+# To create a custom class that extends Prawn's functionality,
+# use the <code>Prawn::View</code> mixin. This approach is safer than creating
+# subclasses of <code>Prawn::Document</code> while being just as convenient.
+#
+# By using this mixin, your state will be kept completely separate
+# from <code>Prawn::Document</code>'s state, and you will avoid accidental method
+# collisions within <code>Prawn::Document</code>.
+#
+# To build custom classes that make use of other custom classes,
+# you can define a method named <code>document()</code> that returns
+# any object that acts similar to a <code>Prawn::Document</code>
+# object. <code>Prawn::View</code> will then direct all delegated
+# calls to that object instead.
+
+require_relative "../example_helper"
+
+class Greeter
+  include Prawn::View
+
+  def initialize(name)
+    @name = name
+  end
+
+  def say_hello
+    text "Hello, #{@name}!"
+  end
+
+  def say_goodbye
+    font("Courier") do
+      text "Goodbye, #{@name}!"
+    end
+  end
+ end
+
+greeter = Greeter.new("Gregory")
+
+greeter.say_hello
+greeter.say_goodbye
+
+greeter.save_as("greetings.pdf")

data/manual/bounding_box/bounding_box.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+#
+# Examples for bounding boxes.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+Prawn::ManualBuilder::Example.generate("bounding_box.pdf", :page_size => "FOLIO") do
+
+  package "bounding_box" do |p|
+
+    p.section "Basics" do |s|
+      s.example "creation"
+      s.example "bounds"
+    end
+
+    p.section "Advanced" do |s|
+      s.example "stretchy"
+      s.example "nesting"
+      s.example "indentation"
+      s.example "canvas"
+      s.example "russian_boxes"
+    end
+
+    p.intro do
+      prose("Bounding boxes are the basic containers for structuring the content flow. Even being low level building blocks sometimes their simplicity is very welcome.
+
+      The examples show:")
+
+      list( "How to create bounding boxes with specific dimensions",
+            "How to inspect the current bounding box for its coordinates",
+            "Stretchy bounding boxes",
+            "Nested bounding boxes",
+            "Indent blocks"
+          )
+    end
+
+  end
+end

data/manual/bounding_box/bounds.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+#
+# The <code>bounds</code> method returns the current bounding box. This is
+# useful because the <code>Prawn::BoundingBox</code> exposes some nice boundary
+# helpers.
+#
+# <code>top</code>, <code>bottom</code>, <code>left</code> and
+# <code>right</code> methods return the bounding box boundaries relative to its
+# translated origin. <code>top_left</code>, <code>top_right</code>,
+# <code>bottom_left</code> and <code>bottom_right</code> return those boundaries
+# pairs inside arrays.
+#
+# All these methods have an "absolute" version like <code>absolute_right</code>.
+# The absolute version returns the same boundary relative to the page absolute
+# coordinates.
+#
+# The following snippet shows the boundaries for the margin box side by side
+# with the boundaries for a custom bounding box.
+#
+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
+  def print_coordinates
+    text "top: #{bounds.top}"
+    text "bottom: #{bounds.bottom}"
+    text "left: #{bounds.left}"
+    text "right: #{bounds.right}"
+
+    move_down 10
+
+    text "absolute top: #{sprintf "%.2f", bounds.absolute_top}"
+    text "absolute bottom: #{sprintf "%.2f", bounds.absolute_bottom}"
+    text "absolute left: #{sprintf "%.2f", bounds.absolute_left}"
+    text "absolute right: #{sprintf "%.2f", bounds.absolute_right}"
+  end
+
+  text "Margin box bounds:"
+  move_down 5
+  print_coordinates
+
+  bounding_box([250, cursor + 140], :width => 200, :height => 150) do
+    text "This bounding box bounds:"
+    move_down 5
+    print_coordinates
+    transparent(0.5) { stroke_bounds }
+  end
+end

data/manual/bounding_box/canvas.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+#
+# The origin example already mentions that a new document already comes with
+# a margin box whose bottom left corner is used as the origin for calculating
+# coordinates.
+#
+# What has not been told is that there is one helper for "bypassing" the margin
+# box: <code>canvas</code>. This method is a shortcut for creating a bounding
+# box mapped to the absolute coordinates and evaluating the code inside it.
+#
+# The following snippet draws a circle on each of the four absolute corners.
+#
+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
+  canvas do
+    fill_circle [bounds.left, bounds.top],     30
+    fill_circle [bounds.right, bounds.top],    30
+    fill_circle [bounds.right, bounds.bottom], 30
+    fill_circle [0, 0],                        30
+  end
+end

data/manual/bounding_box/creation.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+#
+# If you've read the basic concepts examples you probably know that the origin
+# of a page is on the bottom left corner and that the content flows from top to
+# bottom.
+#
+# You also know that a Bounding Box is a structure for helping the content flow.
+#
+# A bounding box can be created with the <code>bounding_box</code> method. Just
+# provide the top left corner, a required <code>:width</code> option and an
+# optional <code>:height</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
+  bounding_box([200, cursor - 100], :width => 200, :height => 100) do
+    text "Just your regular bounding box"
+
+    transparent(0.5) { stroke_bounds }
+  end
+end

data/manual/bounding_box/indentation.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+#
+# Sometimes you just need to indent a portion of the contents of a bounding box,
+# and using a nested bounding box is pure overkill. The <code>indent</code>
+# method is what you might need.
+#
+# Just provide a number for it to indent all content generated inside the
+# block.
+#
+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 "No indentation on the margin box."
+  indent(20) do
+    text "Some indentation inside an indent block."
+  end
+  move_down 20
+
+  bounding_box([50, cursor], :width => 400, :height => cursor) do
+    transparent(0.5) { stroke_bounds }
+
+    move_down 10
+    text "No indentation inside this bounding box."
+    indent(40) do
+      text "Inside an indent block. And so is this horizontal line:"
+
+      stroke_horizontal_rule
+    end
+    move_down 10
+    text "No indentation"
+
+    move_down 20
+    indent(60) do
+      text "Another indent block."
+
+      bounding_box([0, cursor], :width => 200) do
+        text "Note that this bounding box coordinates are relative to the " +
+             "indent block"
+
+        transparent(0.5) { stroke_bounds }
+      end
+    end
+  end
+end