burr 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f849154fa08f4e730346d3f7568008af38b5a0d4
+  data.tar.gz: 04056ac1475498bcfa8afd2eeb8d4313f96b2bf2
+SHA512:
+  metadata.gz: 0d046ab33e9dbe39a8a04eb2741a92777be18e3f2b4ae8be5be847d26b1df564452b47fb96d952aa39037ad00dfb445f75ca1164eed3b955954c8d55169ef06e
+  data.tar.gz: 1d1fd65b40f58bc4333c0a93d42ae136cd4e182d3575bdc81e95198db184df88ab733881a6c0de05ddac8c2d50949490c6713be85ac64ec855571eddbc95cd8a

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+*.gem
+pkg/

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,30 @@
+# License #
+
+## Application Code ##
+
+Copyright (c) 2012 Andor Chen <andor.chen.27@gmail.com>
+
+Some ideas and minor portions of code inspired by easybook project:
+Copyright (c) 2012 Javier Eguiluz <javier.eguiluz@gmail.com> (details: https://github.com/javiereguiluz/easybook/blob/master/LICENSE.md)
+
+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.
+
+## Dependency gems ##
+
+See their own license files

data/README.md

@@ -0,0 +1,180 @@
+# burr
+
+[![Dependency Status](https://gemnasium.com/AndorChen/burr.png)](https://gemnasium.com/AndorChen/burr)
+
+burr 是一个电子书制作工具（命令行）。使用 Markdown 编写书籍内容，burr 可以将其转换成 PDF，ePub 和 Mobi 格式电子书。还能生成 HTML 格式，提供书籍在线阅读。
+
+## 目的
+
+一份文稿，四种输出。
+
+## 示例
+
+《Ruby on Rails 教程》这本书的电子书，以及在线阅读版就是使用 burr 制作的。
+
+<http://railstutorial-china.org>
+
+## 特性
+
+### 整体
+
+- 章节自动编号；
+- 图片自动编号；
+- 表格自动编号；
+- 代码片段自动编号；
+
+### PDF 格式
+
+- 自动生成目录；
+- 自动生成书签；
+- 自动生成交叉引用；
+- 样式可定制；
+
+### ePub 格式
+
+- 元信息完整；
+- 支持图书封面；
+- 兼容各主要阅读器（多看，Kindle 等）；
+- 自动生成目录；
+- 自动生成交叉引用；
+- 样式可定制；
+
+### mobi 格式
+
+- 元信息完整；
+- 支持图书封面；
+- 兼容各主要阅读器（Kindle 等）；
+- 自动生成目录；
+- 自动生成交叉引用；
+
+### HTML 在线阅读
+
+- 自动生成各章内容；
+- 自动生成各章目录；
+- 自动生成交叉引用；
+- 样式可定制；
+
+## 安装
+
+### 依赖程序
+
+burr 只是一个 wrapper，电子书都是通过其他程序生成的。其中 PDF 使用 [PrinceXML](http://www.princexml.com/)，ePub 使用 [eeepub](https://github.com/jugyo/eeepub)，mobi 使用 [kindlegen](http://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000765211)。所以在使用 burr 之前，请确保安装了这些程序。具体的安装过程请参照相应程序的安装说明。
+
+### burr 本身
+
+burr 是一个 Ruby gem，可以像其他 gem 一样安装。但是由于没有推送到 Rubygems.org，所以无法使用 `gem install` 命令安装。
+
+在项目的 `Gemfile` 中加入以下代码：
+
+```ruby
+gem 'burr', github: 'andorchen/burr'
+```
+
+然后执行 `bundle` 命令安装。
+
+## 使用方法
+
+### 生成新项目
+
+执行 `burr new [path]` 命令会生成一个新项目，生成的目录结构如下：
+
+```text
+- Gemfile
+- config.yml               # 项目设置
+- contents                 # 书稿文件夹
+  |- contents/chapter1.md
+  |- contents/chapter2.md
+- outputs                  # 电子书输出文件夹
+  |- pdf/
+     |- style.css
+  |- site/
+     |- figures/           # 书中所用图片
+     |- style.css
+  |- epub/
+  |- mobi/
+  |- caches/               # 缓存文件夹，暂时未用
+     |- code/
+```
+
+### 生成电子书
+
+```sh
+$ burr export pdf
+$ burr export epub
+$ burr export mobi
+$ burr export site
+```
+
+### 帮助
+
+更多命令请执行 `burr help` 命令查看。
+
+## 原理
+
+1. 使用 Markdown 语法（[kramdown](http://kramdown.rubyforge.org/index.html)）撰写文稿；
+2. burr 根据 `config.yml` 中的设置，套用模板将 Markdown 转换成 HTML 文档；
+3. 电子书生成工具将 HTML 文档转换成电子书。
+
+## 文稿格式
+
+burr 使用 kramdown 的语法，并做了适当扩展。
+
+### burr 的扩展
+
+#### 附加信息（来自 Leanpub）
+
+```text
+A> #### 旁注标题
+A>
+A> 注意 > 符号后面要留一个空格。
+A>
+A> 如果旁注中有脚注，一定要写在旁注内。[^fn-1]
+A>
+A> [^fn-1]: 这是一个脚注。
+```
+
+```text
+W> #### 警告
+W>
+W> 这是一则警告：侵权必究！
+```
+
+```text
+T> #### 小贴士
+T>
+T> 夏天空调温度不要开的过低哟。
+```
+
+其他附加信息类型，请参考 [Leanpub 的帮助文档](https://leanpub.com/help/manual#leanpub-auto-asidessidebars)。
+
+#### 代码块
+
+kramdown 原生支持的代码块由 `~~~` 分隔，但我更习惯使用 GitHub 的句法，所以 burr 提供了对后者的支持。除此之外，因为计算机书籍经常会为代码块加入说明及所在文件位置，所以 burr 利用 kramdown 的 [Block Inline Attribute Lists](http://kramdown.rubyforge.org/syntax.html#block-ials) 实现了这一功能，使用方法如下：
+
+
+	```ruby
+	def hello
+  	  puts "Hello, burr!"
+	end
+	```
+	{:caption="Ruby 方法定义示例" file="/path/to/file.rb"}
+
+代码高亮通过 [pygments.rb](https://github.com/tmm1/pygments.rb) 实现。
+
+### 图片题注
+
+```text
+![alt text](path/to/image.jpg){:caption="示例图片"}
+```
+
+## 作者
+
+[Andor Chen](http://about.ac)
+
+## 发布协议
+
+[MIT](LICENSE.md)
+
+## 致谢
+
+在 burr 开发中借鉴了 [easybook](https://github.com/javiereguiluz/easybook/) 的很多思路，特此感谢。

data/Rakefile

@@ -0,0 +1,118 @@
+$:.unshift(File.join(File.dirname(__FILE__), *%w[lib]))
+
+require 'rake'
+require 'rdoc'
+require 'date'
+
+require 'burr'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  Burr::Version::STRING
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => [:test, :features]
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "--format progress"
+  end
+rescue LoadError
+  desc 'Cucumber rake task not available'
+  task :features do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc 'Release the gem, push to github and rubygems.org'
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc 'Build the gem and then move to /pkg'
+task :build do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+

data/bin/burr

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'burr/ruby_version_check'
+
+require 'burr'
+
+Burr::Cli.start

data/burr.gemspec

@@ -0,0 +1,36 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'burr/version'
+
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+
+  s.name              = 'burr'
+  s.version           = Burr::Version::STRING
+  s.license           = 'MIT'
+  s.date              = '2013-04-21'
+
+  s.summary     = "电子书制作工具"
+  s.description = "使用 Markdown 编写书籍内容，通过 burr 将其转换成 PDF，ePub 和 Mobi 格式电子书。"
+
+  s.authors  = ["Andor Chen"]
+  s.email    = 'andor.chen.27@gmail.com'
+  s.homepage = 'https://github.com/AndorChen/burr'
+
+  s.require_paths = %w[lib]
+
+  s.executables = ["burr"]
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE.md]
+
+  s.add_runtime_dependency('nokogiri',    '~> 1.6.0')
+  s.add_runtime_dependency('thor',        '~> 0.18.1')
+  s.add_runtime_dependency('liquid',      '~> 2.5.4')
+  s.add_runtime_dependency('kramdown',    '~> 1.2.0')
+  s.add_runtime_dependency('pygments.rb', '~> 0.5.4')
+  s.add_runtime_dependency('eeepub',      '~> 0.8.1')
+
+  s.files = `git ls-files`.split($/)
+end

data/generators/Gemfile.txt

@@ -0,0 +1,3 @@
+source :rubygems
+
+gem 'burr', '~> 0.0.1'

data/generators/config.yml

@@ -0,0 +1,55 @@
+title:      'Sample Book'
+subtitle:   ''
+slug:       ''
+author:     'Your Name'
+translator: ''
+edition:    'First edition'
+language:   'zh_CN'
+publisher:  ''
+pubdate:    ''
+isbn:       ''
+identifier: '' # only for epub
+id_scheme:  '' # only for epub
+
+contents:
+  # available content types: acknowledgement, afterword, appendix, author,
+  # blank, chapter, conclusion, cover, dedication, edition, epilogue, foreword,
+  # glossary, introduction, license, lof (list of figures), lot (list of
+  # tables), part, preface, prologue, title, toc (table of contents)
+  - { element: cover }
+  - { element: toc   }
+  - { element: chapter, number: 1, file: chapter1.md }
+  - { element: chapter, number: 2, file: chapter2.md }
+
+formats:
+  pdf:
+    label:
+      deep:     3
+      elements: ['appendix', 'chapter', 'part'] # labels also available for: "figure", "table", "codeblock"
+    toc:
+      deep:     2
+      elements: ['appendix', 'chapter', 'part']
+
+  site:
+    label:
+      deep:     3
+      elements: ['appendix', 'chapter'] # labels also available for: "figure", "table", "codeblock"
+    toc:
+      deep:     2 # toc in single page
+      elements: ['appendix', 'chapter']
+
+  epub:
+    label:
+      deep:     3
+      elements: ['appendix', 'chapter', 'part'] # labels also available for: "figure", "table", "codeblock"
+    toc:
+      deep:     1
+      elements: ['appendix', 'chapter', 'part']
+
+  mobi:
+    label:
+      deep:     3
+      elements: ['appendix', 'chapter', 'part'] # labels also available for: "figure", "table", "codeblock"
+    toc:
+      deep:     1
+      elements: ['appendix', 'chapter', 'part']