mkbok 0.0.10 → 0.0.11

data/bin/mkbok

@@ -5,6 +5,7 @@ require 'optparse'
 require 'fileutils'
 require 'erb'
 require 'yaml'
+require 'pathname'
 
 include FileUtils
 
@@ -65,6 +66,13 @@ def main()
             end
             options["name"] = name
         end
+        opts.on("-g","--generate project","project name") do |name|
+            unless name =~ /^[a-zA-Z0-9]+$/
+                raise ArgumentError,"name should be [a-zA-Z0-9]"
+            end
+            options["command"] = "generate"
+            options["name"] = name
+        end        
     end
 
     option_parser.parse!
@@ -77,7 +85,12 @@ def main()
     options["outputformat"] = options["build"].split(',')
 
     puts options.inspect if options["debug"]
-      
+    
+    if options["command"] == "generate"
+        generate_project(options["name"])
+        exit
+    end
+    
     if options["outputformat"].include?("pdf")
         #puts "pdf"
         generate_pdf(options)
@@ -372,5 +385,37 @@ def generate_ebook(options)
     end
 end
 
+# http://stackoverflow.com/questions/5074327/most-appropriate-way-to-generate-directory-of-files-from-directory-of-template-f
+def generate_project(project)
+    destination = project
+    source = File.dirname(__FILE__)+"/../templates"
+    #puts "generate project \"#{destination}\" from source \"#{source}\""
+    FileUtils.rmtree(destination)
+    FileUtils.mkdir_p(destination)
+    sourceroot=Pathname.new(source)
+    sourcerealpath = sourceroot.cleanpath
+    puts "generate project \"#{destination}\" from source \"#{sourcerealpath}\""     
+    Dir.glob(File.join(source, '**/*')).each do |path|
+      pathname = Pathname.new(path)
+      relative = pathname.relative_path_from(sourceroot)
+      #puts "parent:" , sourceroot
+      #puts "relative:", relative
+      if File.directory?(pathname) 
+        destdir = File.join(destination, relative.dirname)
+        #puts "create #{destdir} "
+        FileUtils.mkdir_p(destdir) 
+      else
+          FileUtils.mkdir_p(File.join(destination, relative.dirname))
+          if pathname.extname == '.erb'
+            File.open(destination.join(pathname.basename.sub(/\.erb$/, '')), 'w') do |file|
+              file.puts(ERB.new(File.read(path)).result(binding))
+            end   
+          else
+            print pathname.cleanpath, " => ", File.join(destination, relative.dirname),"\n"
+            FileUtils.cp(pathname, File.join(destination, relative.dirname))
+          end
+      end
+    end
+end
 main
 

data/lib/mkbok_version.rb

@@ -1,3 +1,3 @@
 module MkBok
-  VERSION = '0.0.10'
+  VERSION = '0.0.11'
 end

data/templates/BUILD.md

@@ -0,0 +1,43 @@
+# Introduction #
+
+As open source books, ebooks and pdf format should be created on fly, the following sections describe those solution in detail.
+
+The solution below is based on [Pro Git][progit]; while it is little updated on format inside. 
+
+# Making Pdf books #
+PDF format is used to read/print in nice way like real book, [pandoc][pandoc] good at this and it is used instead to generate latex from markdown, and latex tool `xelatex` (is part of [TexLive][texlive] now) is used to convert pdf from latex.
+
+Please check [ctax](http://www.ctan.org/) and [TexLive][texlive] for more background for latex, which is quite complicated and elegant if you have never touched before.
+
+## Ubuntu Platform ##
+
+Ubuntu Platform Oneiric (11.10) is used mainly due to pandoc. 
+
+[pandoc][pandoc] can be installed directly from source, which version is 1.8.x. If you use Ubuntu 11.04, then it is just 1.5.x.
+
+Though texlive 2011 can be installed separately, the default one texlive 2009 from Ubuntu repository is good enough so far. 
+
+    $ sudo apt-get install ruby1.9.1
+    $ sudo apt-get install pandoc
+    $ sudo apt-get install texlive-xetex
+    $ sudo apt-get install texlive-latex-recommended # main packages
+    $ sudo apt-get install texlive-latex-extra # package titlesec
+	
+You need to install related fonts for Chinese, fortunately they exist in ubuntu source also.
+    
+    $ sudo apt-get install ttf-arphic-gbsn00lp ttf-arphic-ukai # from arphic 
+	$ sudo apt-get install ttf-wqy-microhei ttf-wqy-zenhei # from WenQuanYi
+
+Then it should work perfectly
+
+	$ ./mkbok
+
+Just remind you, some [extra pandoc markdown format](http://johnmacfarlane.net/pandoc/README.html) is used inside this book:
+
+  * code syntax highlight (doesn't work in pdf, while it should work in html/epub which needed later)
+  * footnote
+    	
+[pandoc]: http://johnmacfarlane.net/pandoc/    
+[calibre]: http://calibre-ebook.com/
+[progit]: http://github.com/progit/progit 
+[texlive]: http://www.tug.org/texlive/

data/templates/README.md

@@ -0,0 +1,20 @@
+# Software Development Book Contents#
+
+[![Build Status](https://secure.travis-ci.org/larrycai/kaiyuanbook.png)](http://travis-ci.org/larrycai/kaiyuanbook)
+
+This is the book for how to write opensource books, it covers markdown,pandoc,latex
+
+Hope you enjoy it, I hope it helps you learn better software development. 
+
+Please check BUILD.md for how to making ebooks by yourself, 
+
+credit to [Pro Git](http://github.com/progit/progit) 
+
+#Errata#
+
+If you see anything that is technically wrong or otherwise in need of
+correction, please email me at larry dot caiyu at gmail dot com to inform me.
+
+### License
+  The license is under ![](http://i.creativecommons.org/l/by-nc-nd/3.0/88x31.png), see [CC BY NC ND 3.0](http://creativecommons.org/licenses/by-nc-nd/3.0/) for more
+

data/templates/Rakefile

@@ -0,0 +1,160 @@
+# encoding: UTF-8
+
+require 'rake/clean'
+
+
+$lang = ENV['language']
+$lang ||= 'en'
+
+namespace :epub do
+	TMP_DIR = File.join('epub', 'temp', $lang)
+	INDEX_FILEPATH = File.join(TMP_DIR, 'sdcamp.html')
+	TARGET_FILEPATH = "sdcamp-#{$lang}.epub"
+	
+	SOURCE_FILES = FileList.new(File.join($lang, '**', '*.markdown')).sort
+	CONVERTED_MK_FILES = SOURCE_FILES.pathmap(File.join(TMP_DIR, '%f'))
+	HTML_FILES = CONVERTED_MK_FILES.ext('html') 
+	
+	desc "generate EPUB ebook (add language=xx to build lang xx)"
+	task :generate => :check
+	task :generate => TARGET_FILEPATH
+	
+	desc "check whether all the required tools are installed"
+	task :check do
+		begin
+			require 'maruku'
+			found_maruku = true
+		rescue LoadError
+			found_maruku = false
+		end
+		
+		$ebook_convert_cmd = ENV['ebook_convert_path'].to_s
+		if $ebook_convert_cmd.empty?
+			$ebook_convert_cmd = `which ebook-convert`.chomp
+		end
+		if $ebook_convert_cmd.empty?
+			mac_osx_path = '/Applications/calibre.app/Contents/MacOS/ebook-convert'
+			$ebook_convert_cmd = mac_osx_path
+		end
+		found_calibre = File.executable?($ebook_convert_cmd)
+		
+		if !found_maruku
+			puts 'EPUB generation requires the Maruku gem.'
+			puts '  On Ubuntu call "sudo apt-get install libmaruku-ruby".'
+		end
+		if !found_calibre
+			puts 'EPUB generation requires Calibre.'
+			puts '  On Ubuntu call "sudo apt-get install calibre".'
+		end
+		
+		if !found_calibre || !found_maruku then exit 1 end
+	end
+	
+	directory TMP_DIR
+	
+	rule '.html' => '.mk' do |t|
+		require 'maruku'
+		
+		mk_filename = t.source
+		html_filename = t.name
+		puts "Converting #{mk_filename} -> #{html_filename}"
+		
+		mk_file = File.open(mk_filename, 'r') do |mk|
+			html_file = File.open(html_filename, 'w') do |html|
+				code = Maruku.new(mk.read.encode("UTF-8")).to_html
+				code.gsub!(/^(<h.) (id='[^']+?')/, '\1')
+				html << code
+				html << "\n"
+			end
+		end
+	end
+	
+	src_for_converted = proc do |dst|
+		base_name = dst.pathmap('%n')
+		SOURCE_FILES.find { |s| s.pathmap('%n') == base_name }
+	end
+	
+	rule '.mk' => src_for_converted do |t|
+		src_filename = t.source
+		dest_filename = t.name
+		puts "Processing #{src_filename} -> #{dest_filename}"
+		
+		figures_dir = "../../../figures"
+		
+		dest_file = File.open(dest_filename, 'w')
+		src_file = File.open(src_filename, 'r')
+		until src_file.eof?
+			line = src_file.readline
+			
+			matches = line.match /^\s*Insert\s(.*)/
+			if matches
+				image_path = matches[1]
+				real_image_path = image_path.pathmap("#{figures_dir}/%X-tn%x")
+				
+				next_line = src_file.readline.chomp
+				
+				line = "![#{next_line}](#{real_image_path} \"#{next_line}\")\n"
+			end
+			
+			dest_file << line
+		end
+		src_file.close
+		dest_file.close
+	end
+	
+	file INDEX_FILEPATH => TMP_DIR
+	file INDEX_FILEPATH => HTML_FILES do
+		index_file = File.open(INDEX_FILEPATH, 'w') do |file|
+			file << '<?xml version="1.0" encoding="UTF-8"?>'
+			file << "\n"
+			file << '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" '
+			file << '"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">'
+			file << "\n"
+			file << "<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='#{$lang}'>"
+			file << '<head>'
+			file << '<title>Pro Git - professional version control</title>'
+			file << '</head>'
+			file << '<body>'
+			file << "\n"
+			
+			HTML_FILES.each do |chapter_file|
+				file << File.open(chapter_file).read
+				file << "\n"
+			end
+			
+			file << '</body></html>'
+			file << "\n"
+		end
+	end
+	
+	file TARGET_FILEPATH => INDEX_FILEPATH do
+		opts = [
+			'--language', $lang,
+			'--authors', 'Scott Chacon',
+			'--comments', 'Licensed under the Creative Commons Attribution-Non Commercial-Share Alike 3.0 license',
+			
+			'--cover', 'epub/title.png',
+			'--extra-css', 'epub/ProGit.css',
+			
+			'--chapter', '//h:h1',
+			'--level1-toc', '//h:h1',
+			'--level2-toc', '//h:h2',
+			'--level3-toc', '//h:h3',
+		]
+		
+		sh $ebook_convert_cmd, INDEX_FILEPATH, TARGET_FILEPATH, *opts
+	end
+	
+	CLEAN.push(*CONVERTED_MK_FILES)
+	CLEAN.push(*HTML_FILES)
+	CLEAN << INDEX_FILEPATH
+	CLEAN << TMP_DIR
+	CLOBBER << TARGET_FILEPATH
+end
+
+namespace :pdf do
+        desc "generate a pdf"
+        task :generate  do
+                system("ruby makepdfs")
+        end
+end

data/templates/epub/book.css

@@ -0,0 +1,28 @@
+ul {
+	margin: 20px;
+}
+
+ol {
+	margin: 20px;
+}
+
+body pre {
+	margin: 10px;
+	font-weight: bold;
+}
+
+body pre2 {
+	background-color: silver;
+	padding: 10px;
+	border-top-style: solid;
+	border-left-style: solid;
+	border-left-width: 1px;
+	border-top-width: 1px;
+	overflow-x: auto; /* Use horizontal scroller if needed; for Firefox 2, not needed in Firefox 3 */
+	white-space: pre-wrap; /* css-3 */
+	white-space: -moz-pre-wrap !important; /* Mozilla, since 1999 */
+	white-space: -pre-wrap; /* Opera 4-6 */
+	white-space: -o-pre-wrap; /* Opera 7 */
+ /* width: 99%; */
+	 word-wrap: break-word; /* Internet Explorer 5.5+ */
+ }

data/templates/epub/metadata.xml

@@ -0,0 +1,2 @@
+<dc:rights>Creative Commons Non-Commercial Share Alike 3.0</dc:rights>
+<dc:language>zh</dc:language>

data/templates/figures-source/cover.bmml

@@ -0,0 +1,45 @@
+<mockup version="1.0" skin="sketch" measuredW="1052" measuredH="1382" mockupW="1052" mockupH="1382">
+  <controls>
+    <control controlID="2" controlTypeID="com.balsamiq.mockups::Title" x="78" y="512" w="-1" h="-1" measuredW="664" measuredH="87" zOrder="2" locked="false" isInGroup="-1">
+      <controlProperties>
+        <color>16777215</color>
+        <size>72</size>
+        <text>Software%20Development</text>
+      </controlProperties>
+    </control>
+    <control controlID="4" controlTypeID="com.balsamiq.mockups::Canvas" x="3" y="498" w="807" h="334" measuredW="100" measuredH="70" zOrder="1" locked="false" isInGroup="-1">
+      <controlProperties>
+        <backgroundAlpha>0.75</backgroundAlpha>
+        <borderColor>0</borderColor>
+        <color>545684</color>
+      </controlProperties>
+    </control>
+    <control controlID="5" controlTypeID="com.balsamiq.mockups::Canvas" x="187" y="0" w="651" h="50" measuredW="100" measuredH="70" zOrder="5" locked="false" isInGroup="-1">
+      <controlProperties>
+        <backgroundAlpha>0.75</backgroundAlpha>
+        <borderColor>0</borderColor>
+        <color>545684</color>
+      </controlProperties>
+    </control>
+    <control controlID="6" controlTypeID="com.balsamiq.mockups::TextArea" x="0" y="0" w="1052" h="1382" measuredW="200" measuredH="140" zOrder="0" locked="false" isInGroup="-1">
+      <controlProperties>
+        <text/>
+      </controlProperties>
+    </control>
+    <control controlID="7" controlTypeID="com.balsamiq.mockups::Label" x="512" y="716" w="413" h="61" measuredW="218" measuredH="39" zOrder="3" locked="false" isInGroup="-1">
+      <controlProperties>
+        <italic>true</italic>
+        <size>28</size>
+        <text>Learning%20in%204%20days</text>
+      </controlProperties>
+    </control>
+    <control controlID="8" controlTypeID="com.balsamiq.mockups::Label" x="708" y="1272" w="-1" h="-1" measuredW="132" measuredH="43" zOrder="4" locked="false" isInGroup="-1">
+      <controlProperties>
+        <color>6710886</color>
+        <italic>true</italic>
+        <size>32</size>
+        <text>Larry%20Cai</text>
+      </controlProperties>
+    </control>
+  </controls>
+</mockup>

data/templates/latex/README

@@ -0,0 +1,27 @@
+PDF Version of Pro Git
+======================
+
+To get a PDF version of Pro Git in English, run `makepdf en` and a file called
+`progit.en.pdf` will appear in the root of the project. `makepdf` required
+pandoc and XeTeX as dependencies.
+
+* `config.yml`: this is a simple configuration file which allows you to
+  specify language-specific customisations.
+* `template.tex`: this is the main LaTeX file which determines the style of the
+  PDF version of the book. Its contents is run through the ERB templating
+  language to include language-specific customisations from config.yml.
+
+
+For Windows
+===========
+
+Windows build is tested with Pandoc 1.8 and MixTeX 2.9. Install MixTeX with all
+font options. Only `en` has been tested so far. To make it work, it needs some
+tweaks.
+
+* `pandoc` and `xelatex` binaries must be on the PATH
+* Change the default fonts in `config.yml` to something that exists in Windows.
+  Example for working fonts:
+    font: Latin Modern Roman
+    mono: Courier
+    bold: "{*}"

data/templates/latex/config.yml

@@ -0,0 +1,138 @@
+default:
+  title: Learn writing opensource book
+  font: Liberation Serif
+  bold: "{* Bold}"
+  mono: Liberation Mono
+  prechap: "Chapter "
+  postchap: ""
+  presect: "Section "
+  postsect: ""
+  dql: "“"
+  dqr: "”"
+  con: "Contents"
+  fig: "Figure "
+  tab: "Table "
+  indent: "\\qquad"
+  thanks: "This is the PDF file for the how to write opensource book contents. It is licensed under the Creative Commons Attribution-Non Commercial-Share Alike 3.0 license. I hope you enjoy it, I hope it helps you learn the software development, and I hope you'll continuously watch this : \\url{http://github.com/larrycai/kaiyuanbook}, will be happy if you follow my weibo \\url{http://weibo.com/larrycaiyu}, and if you want to donate, please visit: \\url{https://me.alipay.com/larrycai}"
+zh:
+  title: 跟我学开源技术书
+  langrule: "\\XeTeXlinebreakskip=0em plus 0.1em minus 0.01em\n\\XeTeXlinebreakpenalty=0"
+  font: AR PL SungtiL GB
+  bold: WenQuanYi Micro Hei
+  mono: WenQuanYi Zen Hei Mono
+  # AR is 文鼎字体，中文缺省 http://www.arphic.com/cn/home.html
+  # http://www.debian.org/international/Chinese/software
+  # AR PL UMing: 文鼎PL细上海宋 : 句号有问题
+  # AR PL UKai: 文鼎PL中楷
+  # AR PL SungtiL GB : 文鼎PL简报宋 ， * (item) 有问题！为空
+  # AR PL KaitiM GB : 文鼎PL简中楷
+  # WenQuanYi is 文泉驿 http://wenq.org/
+  # WenQuanYi Bitmap Song: 点阵宋 (! had problem ?)
+  # WenQuanYi Micro Hei：微米黑
+  # WenQuanYi Zen Hei Mono：正黑
+  # Adobe Song Std: Adobe 宋体 ， * (item) 有问题！为框
+  #
+  # default below
+  #font: AR PL UMing CN 
+  #bold: AR PL UKai CN
+  #mono: AR PL UKai CN  
+  prechap: "第"
+  postchap: "章"
+  presect: ""
+  postsect: "节"
+  con: "目录"
+  fig: "图 "
+  tab: "表 "
+  # 首段落空两格字。
+  indent: "文文"
+zh-tw:
+  langrule: "\\XeTeXlinebreakskip=0em plus 0.1em minus 0.01em\n\\XeTeXlinebreakpenalty=0"
+  font: AR PL UMing TW
+  bold: AR PL UKai TW
+  mono: AR PL UKai TW
+  prechap: "第"
+  postchap: "章"
+  presect: ""
+  postsect: "節"
+  dql: "『"
+  dqr: "』"
+  con: "目錄"
+  fig: "圖 "
+  tab: "表 "
+  indent: "文"
+ja:
+  langrule: "\\XeTeXlinebreakskip=0em plus 0.1em minus 0.01em\n\\XeTeXlinebreakpenalty=0"
+#  font: Japan
+#  font: Sazanami Mincho
+  font: IPAPMincho
+  bold: VL PGothic
+#  bold: Sazanami Gothic
+#  bold: IPAPGothic
+  mono: VL Gothic
+  prechap: "第"
+  postchap: "章"
+  presect: ""
+  postsect: "節"
+  dql: "『"
+  dqr: "』"
+  con: "目次"
+  fig: "図"
+  tab: "表"
+  indent: "あ"
+ru:
+  prechap: "Глава "
+  presect: "Раздел "
+  con: "Содержание"
+  fig: "Рисунок "
+  tab: "Таблица "
+  dql: "«"
+  dqr: "»"
+cs:
+  prechap: "Kapitola "
+  presect: "Oddíl "
+  dql: "„"
+  dqr: "“"
+  fig: "Obrázek "
+  tab: "Tabulka "
+fr:
+  prechap: "Chapitre "
+  presect: "Section "
+  fig: "Figure "
+  tab: "Tableau "
+  font: Linux Libertine
+  mono: Courier New
+  con: "Table des matières"
+  langrule: "\\frenchspacing\\usepackage{fontspec}\n\\fontspec[Ligatures={Common}]{Linux Libertine}\n"
+  thanks: "Ce fichier PDF est la traduction française du livre Pro Git. Il est publié sous license Creative Commons Attribution-Non Commercial-Share Alike 3.0. J'espère que vous l'apprécierez, qu'il vous permettra d'apprendre à utiliser Git et que vous aiderez Apress en achetant le livre original sur Amazon : \\url{http://tinyurl.com/amazonprogit}"
+  dql: "«\\,"
+  dqr: "\\,»"
+mk:
+  fig: "Слика"
+  con: "Содржина"
+  prechap: "Поглавје"
+  presect: "Секција"
+  dql: "„"
+  dqr: "“"
+  tab: "Табела"
+de:
+  langrule: "\\frenchspacing"
+  dql: "„"
+  dqr: "“"
+ko:
+  langrule: "\\XeTeXlinebreakskip=0em plus 0.1em minus 0.01em\n\\XeTeXlinebreakpenalty=0"
+  font: UnBatang
+  bold: UnGraphic
+  mono: UnDotum
+  prechap: ""
+  postchap: "장"
+  presect: ""
+  postsect: "절"
+  con: "목차"
+  fig: "그림"
+  tab: "표"
+be:
+  prechap: "Глава "
+  presect: "Раздзел "
+  con: "Змест"
+  fig: "Малюнак "
+  tab: "Табліца "