arthurgeek-kitabu 0.2.0

data/History.txt

@@ -0,0 +1,59 @@
+== 0.0.1 2008-06-06
+
+* 1 major enhancement:
+  * Initial release
+
+== 0.0.2 2008-06-09
+* 1 major enhancement
+	* Added textile support
+* Bug fix
+	* Wrong require was throwing an error
+	
+== 0.0.3 2008-06-09
+* Cleaning up the house
+	* README converted to Markdown
+* 1 major enhancement
+	* Added syntax callback for Textile and Markdown
+
+== 0.0.4 2008-06-12
+* 1 major enhancement
+	* Added some textile helpers
+* 1 bug fix
+	* Textile was escaping code inside <pre> blocks
+	
+== 0.0.5 2008-06-17
+* 1 minor changes
+	* Removed frontcover and backcover jpgs
+* 1 bug fix
+	* Line stub (__) now ignores spaces and tabs
+
+== 0.0.6 2008-06-20
+* 1 major change
+	* All rake tasks moved to namespace 'book'
+* 1 major enhancement
+	* Added task book:watch
+
+== 0.0.7 2008-06-21
+* 1 major enhancement
+	* Added Table of Contents based on h2-h6 tags
+	* Added `book:titles` rake task
+* 1 minor enhancement
+	* Added new Textile link tag (similar to Markdown)
+	
+== 0.0.8 2008-06-22
+* 1 minor change
+	* Added Hpricot as dependency
+	* README updated to document highlight syntax
+	
+== 0.0.9 2008-07-25
+* 1 bug fix
+	* Toc#to_s raised an error if book had no h2-h6 tags (thanks @rferraz)
+
+== 0.0.10
+* 2 bug fixes
+	* generator was ignoring directories inside chapter
+	* repeated titles are now numerated to keep id uniqueness 
+
+== 0.1.0
+* 1 bug fix
+	* RedCloth 3.04 now is bundled with bookmaker until version 4 is supported

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Nando Vieira
+
+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.

data/README.markdown

@@ -0,0 +1,220 @@
+Kitabu
+======
+
+* [http://github.com/fnando/kitabu](http://github.com/fnando/kitabu)
+
+DESCRIPTION:
+------------
+
+A framework for creating e-books from Markdown/Textile text markup using Ruby. 
+Using the Prince PDF generator, you'll be able to get high quality PDFs.
+Mac users that have [Textmate](http://macromates.com) installed can have source 
+code highlighted with his/her favorite theme.
+
+While Prince is too expensive (495USD for a single user license), the 
+free version available at [http://www.princexml.com/download/](http://www.princexml.com/download/) generates
+a PDF with a small logo on the first page, which is removed when sent
+to a printer.
+
+FEATURES:
+---------
+
+* Write PDF using Markdown or Textile text markup
+* Book layout support
+* Syntax highlight theme based on Textmate
+* Generate a PDF with a single rake task
+* Table of Contents automatically generated from chapter titles
+
+SYNOPSIS:
+---------
+
+Create a new book with `kitabu mybook`. Kitabu has support for book
+layout and syntax highlight theme. You can specify other settings:
+
+	kitabu mybook --theme=mac_classic
+	kitabu mybook --layout=boom
+
+You can check available layouts and themes with `kitabu --help`
+
+The `kitabu` command creates a directory "mybook" with the 
+following structure:
+
+- book
+	- config.yml
+	- images
+	- output
+	- Rakefile
+	- templates
+		- layout.css
+		- layout.html
+		- syntax.css
+		- user.css
+	- text
+
+The `config.yml` file holds some information about your book; so you'll always
+change it. This is the default generated file:
+
+	title: [Your Book Title]
+	copyright: Copyright (c) 2008 [Your Name], All Rights Reserved
+	authors:
+	  - [Your Name]
+	  - [Other Name]
+	subject: [Write down what your book is about]
+	keywords: [The keywords related to your book]
+	theme: eiffel
+
+If you're writing on a different language, the `user.css` file can override all
+the messages added by the `layout.css`. Examples on doing this coming soon.
+
+Now it's time to write your book. All your book content will be placed on the
+text directory. Kitabu requires you to separate your book into chapters. 
+A chapter is nothing but a directory that holds lots of Markdown/Textile files.
+The book will be generated using every folder/file alphabetically. So be sure 
+to use a sequential numbering as the name. Here's a sample:
+
+- text
+	- 01_Introduction
+		- 01\_introduction.markdown
+	- 02\_What\_is\_Ruby\_on\_Rails
+		- 01\_MVC.markdown
+		- 02\_DRY.markdown
+		- 03\_Convention\_Over\_Configuration.markdown
+	- 03\_Installing\_Ruby\_on\_Rails
+		- 01\_Installing.textile
+		- 02\_Mac\_OS\_X\_instructions.textile
+		- 03\_Windows\_instructions.markdown
+		- 04\_Ubuntu\_Linux\_instructions.markdown
+
+Note that you can use Textile or Markdown at the same time. Just use the 
+`.markdown` or `.textile` file extension.
+
+You'll want to see your progress eventually; it's time for you to generate
+the book PDF. Just run the command `rake kitabu:pdf` and your book will be 
+created on the output directory.
+
+There are other rake tasks you can use:
+
+* `kitabu:html` - generate a html from your content
+* `kitabu:syntaxes` - list all available syntaxes
+* `kitabu:themes` - list all available themes
+* `kitabu:titles` - list all titles and its permalinks
+* `kitabu:watch` - watch `text` for any change and automatically generate html
+
+Kitabu can generate a Table of Contents (TOC) based on your h2-h6 tags. The 
+h1 tag is discarded because it's meant to be the book title. 
+
+If you need to link to a specific chapter, you can use the `kitabu:titles` rake
+task to know what's the permalink that you need. For example, a title 
+`Installing Mac OS X` will have a permalink `installing-mac-os-x` and you can
+link to this chapter by writing
+`"See more on Installing Mac OS X":#installing-mac-os-x` when using 
+Textile.
+
+To generate the TOC, you need to print a variable called `toc`, using the eRb
+tag `<%= toc %>`.
+
+Syntax Highlighting (Mac OS X)
+==============================
+
+If you're using Textile, all you need to do is use the tag `syntax.`. For 
+example, to highlight a code added right into your text, just do something like
+
+	syntax(ruby_on_rails). class User < ActiveRecord::Base
+	  validates_presence_of :login, :password, :email
+	__
+	  validates_uniqueness_of :login, :email
+	end
+
+To keep multiple line breaks into a single code block, add a line `__`;
+Kitabu will replace it when generating the HTML file.
+
+If you want to highlight a file, you need to place it into the `code` 
+directory and call it like this:
+
+	syntax(ruby_on_rails). some_file.rb
+
+You can specify the lines you want to highlight; the example below will 
+highlight lines 10-17 from some_file.rb.
+
+	syntax(ruby_on_rails 10,17). some_file.rb
+
+You can also specify named blocks to highlight. Named blocks are identified
+by `#begin` and `#end` marks. If some_file.rb has the following code
+
+	require "rubygems"
+	require "hpricot"
+	require "open"
+
+	# begin: get_all_h2_tags
+	doc = Hpricot(open('http://simplesideias.com.br'))
+	(doc/"h2").each {|h2| puts h2.inner_text }
+	# end: get_all_h2_tags
+
+you can get the code between `get_all_h2_tags` using
+
+	syntax(ruby#get_all_h2_tags). some_file.rb
+
+*Note:* Makdown uses the same syntax above. You just need to indent your code
+(as usual) and add the `syntax.` thing as the first line.
+
+INSTALL:
+--------
+
+	sudo gem install fnando-kitabu --source http://gems.github.com
+
+or, if you have problem
+
+	git clone git://github.com/fnando/kitabu.git
+	cd kitabu
+	gem build kitabu.gemspec
+	sudo gem install kitabu
+
+If you're a Mac user and have Textmate installed, you can
+generate HTML from your source code with syntax highlight,
+the same way you see in Textmate. First, you need to install
+Oniguruma regular expression library that can be found at 
+[http://www.geocities.jp/kosako3/oniguruma/](http://www.geocities.jp/kosako3/oniguruma/)
+
+Then, you need to install the Ultraviolet gem.
+
+	sudo gem install ultraviolet
+
+REFERENCES:
+-----------
+
+- Textile: [http://hobix.com/textile/](http://hobix.com/textile/)
+- Markdown: [http://daringfireball.net/projects/markdown/syntax](http://daringfireball.net/projects/markdown/syntax)
+
+MAINTAINER
+----------
+ 
+* Nando Vieira ([http://simplesideias.com.br](http://simplesideias.com.br))
+
+CONTRIBUTORS
+------------
+ 
+* Arthur Zapparoli ([http://arthurgeek.net](http://arthurgeek.net))
+
+LICENSE:
+--------
+
+(The MIT License)
+
+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.

data/Rakefile

@@ -0,0 +1,68 @@
+require 'rake'
+
+PKG_FILES = %w( Rakefile kitabu.gemspec History.txt License.txt README.markdown TODO.txt ) + Dir["{app_generators,bin,lib,themes}/**/*"]
+
+spec = Gem::Specification.new do |s|
+  s.name = "kitabu"
+  s.version = "0.2.0"
+  s.summary = "A framework for creating e-books from Markdown/Textile text markup using Ruby."
+  s.authors = ["Nando Vieira"]
+  s.email = ["fnando.vieira@gmail.com"]
+  s.homepage = "http://github.com/fnando/kitabu"
+  s.description = "A framework for creating e-books from Markdown/Textile text markup using Ruby. Using the Prince PDF generator, you'll be able to get high quality PDFs. Mac users that have Textmate installed can have source code highlighted with his favorite theme."
+  s.has_rdoc = false
+  s.files = PKG_FILES
+	s.bindir = "bin"
+	s.executables = "kitabu"
+	
+	# Dependencies
+  s.add_dependency "rubigen"
+  s.add_dependency "discount"
+  s.add_dependency "hpricot"
+  s.add_dependency "unicode"
+  # Requirements
+  s.requirements << "Install the Oniguruma RE library and ultraviolet gem to get Syntax Highlighting (only for TextMate users)"
+end
+
+namespace :gem do
+  # Thanks to the Merb project for this code.
+  desc "Update Github Gemspec"
+    task :update_gemspec do
+      skip_fields = %w(new_platform original_platform specification_version loaded required_ruby_version rubygems_version platform )
+      
+      result = "# WARNING : RAKE AUTO-GENERATED FILE. DO NOT MANUALLY EDIT!\n"
+      result << "# RUN : 'rake gem:update_gemspec'\n\n"
+      result << "Gem::Specification.new do |s|\n"
+      
+      spec.instance_variables.each do |ivar|
+        value = spec.instance_variable_get(ivar)
+        name  = ivar.split("@").last
+        value = Time.now if name == "date"
+        
+        next if skip_fields.include?(name) || value.nil? || value == "" || (value.respond_to?(:empty?) && value.empty?)
+        if name == "dependencies"
+          value.each do |d|
+            dep, *ver = d.to_s.split(" ")
+            result <<  "  s.add_dependency #{dep.inspect}, #{ver.join(" ").inspect.gsub(/[()]/, "").gsub(", runtime", "")}\n"
+          end
+        else
+          case value
+          when Array
+            value =  name != "files" ? value.inspect : value.inspect.split(",").join(",\n")
+          when FalseClass
+          when TrueClass
+          when Fixnum
+          when String
+            value = value.inspect
+          else
+            value = value.to_s.inspect
+          end
+          result << "  s.#{name} = #{value}\n"
+        end
+      end
+      
+      result << "end"
+      File.open(File.join(File.dirname(__FILE__), "#{spec.name}.gemspec"), "w"){|f| f << result}
+    end
+
+end

data/TODO.txt

@@ -0,0 +1,2 @@
+- Create additional layouts
+- Support Linux and Windows (Linux is probably already supported, but need testing to be sure)

data/app_generators/kitabu/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/app_generators/kitabu/kitabu_generator.rb

@@ -0,0 +1,68 @@
+require 'kitabu'
+
+class KitabuGenerator < RubiGen::Base
+
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+
+  default_options :theme => Kitabu::Base.default_theme,
+    :layout => Kitabu::Base.default_layout
+  attr_reader :theme, :layout
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @destination_root = File.expand_path(args.shift)
+    @name = base_name
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      m.directory ''
+      BASEDIRS.each { |path| m.directory path }
+      
+      m.template "Rakefile", "Rakefile"
+      m.template "user.css", "templates/user.css"
+      m.template "layouts/#{@layout}/layout.css", "templates/layout.css"
+      m.template "layouts/#{@layout}/layout.html", "templates/layout.html"
+      m.template "css/#{@theme}.css", "templates/syntax.css"
+      m.template "config.yml", "config.yml", :assigns => {:theme => @theme}
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+The 'kitabu' command creates a new book with a default
+directory structure at the path you specify.
+
+USAGE: #{spec.name} /path/to/your/book [options]
+EOS
+    end
+
+    def add_options!(opts)
+      opts.separator ''
+      opts.separator 'Options:'
+      opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+      opts.on("--layout=LAYOUT_NAME", String,
+        "Define the book layout (#{Kitabu::Base.layouts.join('|')})",
+        "Default: #{Kitabu::Base.default_layout}") { |x| options[:layout] = x }
+      opts.on("--theme=THEME_NAME", String,
+        "Define the syntax highlight theme (#{Kitabu::Base.themes.join('|')})",
+        "Default: #{Kitabu::Base.default_theme}") { |x| options[:theme] = x } if RUBY_PLATFORM =~ /darwin/
+    end
+
+    def extract_options
+      @theme = options[:theme]
+      @layout = options[:layout]
+    end
+
+    BASEDIRS = %w(
+      templates
+      text
+      output
+      images
+      code
+    )
+end