prawn-git 2.0.1

data/manual/graphics/stroke_cap.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+#
+# The cap style defines how the edge of a line or curve will be drawn. There are
+# three types: <code>:butt</code> (the default), <code>:round</code> and
+# <code>:projecting_square</code>
+#
+# The difference is better seen with thicker lines. With <code>:butt</code>
+# lines are drawn starting and ending at the exact points provided. With both
+# <code>:round</code> and <code>:projecting_square</code> the line is projected
+# beyond the start and end points.
+#
+# Just like <code>line_width=</code> the <code>cap_style=</code> method needs an
+# explicit receiver to work.
+#
+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
+
+  self.line_width = 25
+
+  [:butt, :round, :projecting_square].each_with_index do |cap, i|
+    self.cap_style = cap
+
+    y = 250 - i*100
+    stroke_horizontal_line 100, 300, :at => y
+    stroke_circle [400, y], 15
+  end
+end

data/manual/graphics/stroke_dash.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+#
+# This sets the dashed pattern for lines and curves. The (dash) length defines
+# how long each dash will be.
+#
+# The <code>:space</code> option defines the length of the space between the
+# dashes.
+#
+# The <code>:phase</code> option defines the start point of the sequence of
+# dashes and spaces.
+#
+# Complex dash patterns can be specified by using an array with alternating
+# dash/gap lengths for the first parameter (note that the <code>:space</code>
+# option is ignored in this case).
+#
+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
+
+  dash([1, 2, 3, 2, 1, 5], :phase => 6)
+  stroke_horizontal_line 50, 500, :at => 230
+  dash([1, 2, 3, 4, 5, 6, 7, 8])
+  stroke_horizontal_line 50, 500, :at => 220
+
+  base_y = 210
+
+  24.times do |i|
+    length = (i / 4) + 1
+    space = length            # space between dashes same length as dash
+    phase = 0                 # start with dash
+
+    case i % 4
+    when 0 then base_y -= 5
+    when 1 then phase = length        # start with space between dashes
+    when 2 then space = length * 0.5  # space between dashes half as long as dash
+    when 3
+      space = length * 0.5    # space between dashes half as long as dash
+      phase = length          # start with space between dashes
+    end
+    base_y -= 5
+
+    dash(length, :space => space, :phase => phase)
+    stroke_horizontal_line 50, 500, :at => base_y - (2 * i)
+  end
+end

data/manual/graphics/stroke_join.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+#
+# The join style defines how the intersection between two lines is drawn. There
+# are three types: <code>:miter</code> (the default), <code>:round</code> and
+# <code>:bevel</code>
+#
+# Just like <code>cap_style</code>, the difference between styles is better
+# seen with thicker lines.
+#
+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
+
+  self.line_width = 25
+
+  [:miter, :round, :bevel].each_with_index do |style, i|
+    self.join_style = style
+
+    y = 200 - i*100
+    stroke do
+      move_to(100, y)
+      line_to(200, y + 100)
+      line_to(300, y)
+    end
+    stroke_rectangle [400, y + 75], 50, 50
+  end
+end

data/manual/graphics/translate.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+#
+# This transformation is used to translate the user space. Just provide the
+# x and y coordinates for the new 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
+
+  1.upto(3) do |i|
+
+    x = i * 50
+    y = i * 100
+    translate(x, y) do
+
+      # Draw a point on the new origin
+      fill_circle [0, 0], 2
+      draw_text "New origin after translation to [#{x}, #{y}]",
+                :at => [5, -2], :size => 8
+
+      stroke_rectangle [100, 75], 100, 50
+      text_box "Top left corner at [100,75]",
+                :at => [110, 65], :width => 80, :size => 8
+    end
+  end
+end

data/manual/graphics/transparency.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+#
+# Although the name of the method is <code>transparency</code>, what we are
+# actually setting is the opacity for fill and stroke. So <code>0</code> means
+# completely transparent and <code>1.0</code> means completely opaque
+#
+# You may call it providing one or two values. The first value sets fill opacity
+# and the second value sets stroke opacity. If the second value is omitted fill
+# and stroke will have the same opacity.
+#
+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
+
+  self.line_width = 5
+  fill_color "ff0000"
+  fill_rectangle [0, 100], 500, 100
+
+  fill_color "000000"
+  stroke_color "ffffff"
+
+  base_x = 100
+  [[0.5, 1], 0.5, [1, 0.5]].each do |args|
+
+    transparent(*args) do
+      fill_circle [base_x, 100], 50
+      stroke_rectangle [base_x - 20, 100], 40, 80
+    end
+
+    base_x += 150
+  end
+end

data/manual/how_to_read_this_manual.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+#
+# Prawn manual how to read this manual page.
+
+require_relative "example_helper"
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::ManualBuilder::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(Prawn::ManualBuilder::Example::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 throughout the manual is part of standard Prawn. It is defined in this file:
+
+  https://github.com/prawnpdf/prawn/blob/master/lib/prawn/graphics.rb
+  END_TEXT
+
+end

data/manual/images/absolute_position.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+#
+# One of the options that the <code>image</code> method accepts is
+# <code>:at</code>. If you've read some of the graphics examples you are
+# probably already familiar with it. Just provide it the upper-left corner where
+# you want the image placed.
+#
+# While sometimes useful this option won't be practical. Notice that the cursor
+# won't be moved after the image is rendered and there is nothing forbidding the
+# text to overlap with the image.
+#
+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
+  y_position = cursor
+  text "The image won't go below this line of text."
+
+  image "#{Prawn::DATADIR}/images/fractal.jpg", :at => [200, y_position]
+
+  text "And this line of text will go just below the previous one."
+end

data/manual/images/fit.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+#
+# <code>:fit</code> option is useful when you want the image to have the
+# maximum size within a container preserving the aspect ratio without
+# overlapping.
+#
+# Just provide the container width and height pair.
+#
+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
+  size = 300
+
+  text "Using the fit option"
+  bounding_box([0, cursor], :width => size, :height => size) do
+    image "#{Prawn::DATADIR}/images/pigs.jpg", :fit => [size, size]
+    stroke_bounds
+  end
+end

data/manual/images/horizontal.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+#
+# The image may be positioned relatively to the current bounding box. The
+# horizontal position may be set with the <code>:position</code> option.
+#
+# It may be <code>:left</code>, <code>:center</code>, <code>:right</code> or a
+# number representing an x-offset from the left boundary.
+#
+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([50, cursor], :width => 400, :height => 450) do
+    stroke_bounds
+
+    [:left, :center, :right].each do |position|
+      text  "Image aligned to the #{position}."
+      image "#{Prawn::DATADIR}/images/stef.jpg", :position => position
+    end
+
+    text  "The next image has a 50 point offset from the left boundary"
+    image "#{Prawn::DATADIR}/images/stef.jpg", :position => 50
+  end
+end

data/manual/images/images.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+#
+# Examples for embedding images.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+Prawn::ManualBuilder::Example.generate("images.pdf", :page_size => "FOLIO") do
+
+  package "images" do |p|
+
+    p.section "Basics" do |s|
+      s.example "plain_image"
+      s.example "absolute_position"
+    end
+
+    p.section "Relative Positioning" do |s|
+      s.example "horizontal"
+      s.example "vertical"
+    end
+
+    p.section "Size" do |s|
+      s.example "width_and_height"
+      s.example "scale"
+      s.example "fit"
+    end
+
+    p.intro do
+      prose("Embedding images on PDF documents is fairly easy. Prawn supports both JPG and PNG images.
+
+      The examples show:")
+
+      list( "How to add an image to a page",
+            "How place the image on a specific position",
+            "How to configure the image dimensions by setting the width and height or by scaling it"
+          )
+    end
+
+  end
+end

data/manual/images/plain_image.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+#
+# To embed images onto your PDF file use the <code>image</code> method.
+# It accepts the file path of the image to be loaded and some optional
+# arguments.
+#
+# If only the image path is provided the image will be rendered starting on
+# the cursor position. No manipulation is done with the image even if it doesn't
+# fit entirely on the page like 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 "The image will go right below this line of text."
+  image "#{Prawn::DATADIR}/images/pigs.jpg"
+end

data/manual/images/scale.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+#
+# To scale an image use the <code>:scale</code> option.
+#
+# It scales the image proportionally given the provided value.
+#
+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  "Normal size"
+  image "#{Prawn::DATADIR}/images/stef.jpg"
+  move_down 20
+
+  text  "Scaled to 50%"
+  image "#{Prawn::DATADIR}/images/stef.jpg", :scale => 0.5
+  move_down 20
+
+  text  "Scaled to 200%"
+  image "#{Prawn::DATADIR}/images/stef.jpg", :scale => 2
+end

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