htmls_to_pdf 0.0.4 → 0.0.5

data/README.markdown

@@ -32,13 +32,39 @@ For information on PDFKit:
 
 ## BASIC USAGE
 
-You will find six example scripts in the /examples directory.
+You will find seven example scripts in the /examples directory.
 
 After you install HtmlsToPdf and its dependencies, you can write an ordinary Ruby script with the following features:
 
 ### EXAMPLE 1
 
-Annotated version of /examples/get_rubygems_user_guide.rb:
+Annotated version of /examples/get\_rails\_3\_1\_release\_notes.rb:
+
+    # require the gem
+    require 'rubygems'
+    require 'htmls_to_pdf'
+
+    # Get 'Rails 3.1 Release Notes' as pdf file
+    # Source: 'http://guides.rubyonrails.org/3_1_release_notes.html'
+
+    # create an empty hash to hold your configuration options
+    config = {}
+    config[:urls] = ['http://guides.rubyonrails.org/3_1_release_notes.html']
+
+    # set a :savedir key with a string value indicating the directory to create
+    # your PDF file in. If the directory does not exist, it will be created
+    config[:savedir] = '~/Tech/Rails/3.1'
+
+    # set a :savename key with a string value indicating the name of the PDF file
+    config[:savename] = 'Rails_3.1_Release_Notes.pdf'
+
+    # create a new HtmlsToPdf object, passing in your hash, and then call create_pdf
+    # on the new object
+    HtmlsToPdf.new(config).create_pdf
+
+### EXAMPLE 2
+
+Annotated version of /examples/get\_rubygems\_user\_guide.rb:
 
     # require the gem
     require 'rubygems'
@@ -69,36 +95,36 @@ Annotated version of /examples/get_rubygems_user_guide.rb:
     # on the new object
     HtmlsToPdf.new(config).create_pdf
 
-### EXAMPLE 2
+### EXAMPLE 3
 
-Annotated version of /examples/get_coffeescript_meet_backbone.rb:
+Annotated version of /examples/get\_coffeescript\_meet\_backbone.rb:
 
-  require 'rubygems'
-  require 'htmls_to_pdf'
+    require 'rubygems'
+    require 'htmls_to_pdf'
 
-  # Get 'CoffeeScript, Meet Backbone.js' as pdf file
-  # Source: 'http://adamjspooner.github.com/coffeescript-meet-backbonejs/'
+    # Get 'CoffeeScript, Meet Backbone.js' as pdf file
+    # Source: 'http://adamjspooner.github.com/coffeescript-meet-backbonejs/'
 
-  config = {}
-  config[:urls] = ['http://adamjspooner.github.com/coffeescript-meet-backbonejs/']
-  (1..5).each do |val|
-    config[:urls] << 'http://adamjspooner.github.com/coffeescript-meet-backbonejs/0' + val.to_s + '/docs/script.html'
-  end
-  config[:savedir] = '~/Tech/Javascript/COFFEESCRIPT/BACKBONE.JS'
-  config[:savename] = 'CoffeeScript_Meet_Backbone.js.pdf'
+    config = {}
+    config[:urls] = ['http://adamjspooner.github.com/coffeescript-meet-backbonejs/']
+    (1..5).each do |val|
+      config[:urls] << 'http://adamjspooner.github.com/coffeescript-meet-backbonejs/0' + val.to_s + '/docs/script.html'
+    end
+    config[:savedir] = '~/Tech/Javascript/COFFEESCRIPT/BACKBONE.JS'
+    config[:savename] = 'CoffeeScript_Meet_Backbone.js.pdf'
 
-  # If a :css key is given with an array value, the CSS files in the array will be used to generate
-  # the PDF document. This allows you to modify the CSS file(s) to, for example, hide HTML headers,
-  # sidebars and footers you do not wish to appear in your PDF.
-  config[:css] = ['http://adamjspooner.github.com/coffeescript-meet-backbonejs/05/docs/docco.css']
+    # If a :css key is given with an array value, the CSS files in the array will be used to generate
+    # the PDF document. This allows you to modify the CSS file(s) to, for example, hide HTML headers,
+    # sidebars and footers you do not wish to appear in your PDF.
+    config[:css] = ['http://adamjspooner.github.com/coffeescript-meet-backbonejs/05/docs/docco.css']
 
-  # If a :options key is passed with a hash value, that hash will be passed to wkhtmltopdf.
-  # Many options are available through wkhtmltopdf; see: [the wkhtmltopdf documentation](http://madalgo.au.dk/~jakobt/wkhtmltoxdoc/wkhtmltopdf-0.9.9-doc.html).
-  config[:options] = {:page_size => 'Letter', :orientation => 'Landscape'}
+    # If a :options key is passed with a hash value, that hash will be passed to wkhtmltopdf.
+    # Many options are available through wkhtmltopdf; see: [the wkhtmltopdf documentation](http://madalgo.au.dk/~jakobt/wkhtmltoxdoc/wkhtmltopdf-0.9.9-doc.html).
+    config[:options] = {:page_size => 'Letter', :orientation => 'Landscape'}
 
-  HtmlsToPdf.new(config).create_pdf
+    HtmlsToPdf.new(config).create_pdf
 
 ## LEGAL DISCLAIMER
 
-Please use at your own risk. I do not guarantee anything about this program.
+Please use at your own risk. I guarantee nothing about this program.
 

data/examples/get_rails_3_1_release_notes.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'htmls_to_pdf'
+
+# Get 'Rails 3.1 Release Notes' as pdf file
+# Source: 'http://guides.rubyonrails.org/3_1_release_notes.html'
+
+config = {}
+config[:urls] = ['http://guides.rubyonrails.org/3_1_release_notes.html']
+
+config[:savedir] = '~/Tech/Rails/3.1'
+config[:savename] = 'Rails_3.1_Release_Notes.pdf'
+
+HtmlsToPdf.new(config).create_pdf

data/lib/htmls_to_pdf/version.rb

@@ -1,3 +1,3 @@
 module HtmlsToPdf
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/license.txt

@@ -0,0 +1,20 @@
+Copyright (C) 2011 by James K. Lavin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: htmls_to_pdf
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - James Lavin
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-07 00:00:00 Z
+date: 2011-11-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: pdfkit
@@ -70,6 +70,7 @@ files:
 - examples/get_coffeescript_meet_backbone.rb
 - examples/get_exploring_coffeescript.rb
 - examples/get_python_book.rb
+- examples/get_rails_3_1_release_notes.rb
 - examples/get_ruby_book.rb
 - examples/get_rubygems_user_guide.rb
 - htmls_to_pdf.gemspec
@@ -77,6 +78,7 @@ files:
 - lib/htmls_to_pdf/htmls_to_pdf.rb
 - lib/htmls_to_pdf/pdfkit_config.rb
 - lib/htmls_to_pdf/version.rb
+- license.txt
 homepage: 
 licenses: []