prawn 0.12.0 → 0.13.0

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

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::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,31 @@
+# encoding: utf-8
+#
+# Examples for stamps and repeaters.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+Prawn::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.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::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

data/manual/repeatable_content/stamp.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+#
+# Stamps should be used when you have content that will be included multiple
+# times in a document. Its advantages over creating the content anew each time
+# are:
+#   1.  Faster document creation
+#   2.  Smaller final document
+#   3.  Faster display on subsequent displays of the repeated
+# element because the viewer application can cache the rendered
+# results
+#
+# The <code>create_stamp</code> method does just what it says. Pass it a block
+# with the content that should be generated and the stamp will be created.
+#
+# There are two methods to render the stamp on a page <code>stamp</code> and
+# <code>stamp_at</code>. The first will render the stamp as is while the
+# second accepts a point to serve as an offset to the stamp content.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Example.generate(filename) do
+  create_stamp("approved") do
+    rotate(30, :origin => [-5, -5]) do
+      stroke_color "FF3333"
+      stroke_ellipse [0, 0], 29, 15
+      stroke_color "000000"
+    
+      fill_color "993333"
+      font("Times-Roman") do
+        draw_text "Approved", :at => [-23, -3]
+      end
+      fill_color "000000"
+    end
+  end
+  
+  stamp "approved"
+  
+  stamp_at "approved", [200, 200]
+end

data/manual/security/encryption.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+#
+# The <code>encrypt_document</code> method, as you might have already guessed,
+# is used to encrypt the PDF document.
+#
+# Once encrypted whoever is using the document will need the user password to
+# read the document. This password can be set with the
+# <code>:user_password</code> option. If this is not set the document will be
+# encrypted but a password will not be needed to read the document.
+#
+# There are some caveats when encrypting your PDFs. Be sure to read the source
+# documentation (you can find it here:
+# https://github.com/prawnpdf/prawn/blob/master/lib/prawn/security.rb ) before
+# using this for anything super serious.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+
+# Bare encryption. No password needed.
+Prawn::Example.generate("bare_encryption.pdf") do
+  text "See, no password was asked but the document is still encrypted."
+  encrypt_document
+end
+
+
+# Simple password. All permissions granted.
+Prawn::Example.generate("simple_password.pdf") do
+  text "You was asked for a password."
+  encrypt_document(:user_password => 'foo', :owner_password => 'bar')
+end

data/manual/security/permissions.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+#
+# Some permissions may be set for the regular user with the following options:
+# <code>:print_document</code>, <code>:modify_contents</code>,
+# <code>:copy_contents</code>, <code>:modify_annotations</code>. All this
+# options default to true, so if you'd like to revoke just set them to false.
+#
+# A user may bypass all permissions if he provides the owner password which
+# may be set with the <code>:owner_password</code> option. This option may be
+# set to <code>:random</code> so that users will never be able to bypass
+# permissions.
+#
+# There are some caveats when encrypting your PDFs. Be sure to read the source
+# documentation (you can find it here:
+# https://github.com/prawnpdf/prawn/blob/master/lib/prawn/security.rb ) before
+# using this for anything super serious.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+
+# User cannot print the document.
+Prawn::Example.generate("cannot_print.pdf") do
+  text "If you used the user password you won't be able to print the doc."
+  encrypt_document(:user_password => 'foo', :owner_password => 'bar',
+                   :permissions => { :print_document => false })
+end
+
+
+# All permissions revoked and owner password set to random
+Prawn::Example.generate("no_permissions.pdf") do
+  text "You may only view this and won't be able to use the owner password."
+  encrypt_document(:user_password => 'foo', :owner_password => :random,
+                   :permissions => { :print_document     => false,
+                                     :modify_contents    => false,
+                                     :copy_contents      => false,
+                                     :modify_annotations => false })
+end

data/manual/security/security.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+#
+# Examples for document encryption.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+Prawn::Example.generate("security.pdf", :page_size => "FOLIO") do
+  
+  package "security" do |p|
+    
+    p.example "encryption",  :eval_source => false, :full_source => true
+    p.example "permissions", :eval_source => false, :full_source => true
+    
+    p.intro do
+      prose("Security lets you control who can read the document by defining a password.
+
+      The examples include:")
+
+      list( "How to encrypt the document without the need for a password",
+            "How to configure the regular user permitions",
+            "How to require a password for the regular user",
+            "How to set a owner password that bypass the document permissions"
+          )
+    end
+    
+  end
+end

data/manual/syntax_highlight.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require "coderay"
+
+# Registers a to_prawn method on CodeRay. It returns an array of hashes to be
+# used with formatted_text.
+#
+# Usage:
+#
+# CodeRay.scan(string, :ruby).to_prawn
+#
+class PrawnEncoder < CodeRay::Encoders::Encoder
+  register_for :to_prawn
+
+  COLORS = { :default           => "FFFFFF",
+             
+             :comment           => "AEAEAE",
+             :constant          => "88A5D2",
+             :instance_variable => "E8ED97",
+             :integer           => "C8FF0E",
+             :float             => "C8FF0E",
+             :inline_delimiter  => "EF804F",  # #{} within a string
+             :keyword           => "FEE100",
+             
+             # BUG: There appear to be some problem with this token. Method
+             #      definitions are considered as ident tokens
+             #
+             :method            => "FF5C00",
+             :string            => "56D65E",
+             :symbol            => "C8FF0E" 
+           }
+
+  def setup(options)
+    super
+    @out  = []
+    @open = []
+  end
+
+  def text_token(text, kind)
+    color = COLORS[kind] || COLORS[@open.last] || COLORS[:default]
+    
+    @out << {:text => text, :color => color}
+  end
+
+  def begin_group(kind)
+    @open << kind
+  end
+
+  def end_group(kind)
+    @open.pop
+  end
+end