review 0.9.0 → 1.0.0

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+
+branches:
+  only:
+    - master

data/ChangeLog

@@ -1,3 +1,329 @@
+Mon Jan 30 20:39:17 2012  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* Version bump to 1.0.0.
+
+Sat Jan 28 00:28:34 2012  Kenshi Muto  <kmuto@debian.org>
+
+	* //raw supports to indicate builder(s) by using
+	  //raw[|builder,builder| ...]
+	* merge kdmsnr's branch.
+	commit 207c787c961d61bbc517e160effadf417f05e28e
+	unescape in inline_raw: refs #54
+
+Sun Jan 22 19:49:42 2012  Kenshi Muto  <kmuto@debian.org>
+
+	* revert 17b0deb55b599deb1bdfbd6c61957d6edd5977ed change.
+	  It caused a bug that '#@#' was included in paragraphs when
+	  '#@#' was located just after paragraph line.
+
+Sat Jan 14 23:24:52 2012  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/builder.rb, lib/review/htmlbuilder.rb,
+	  lib/review/i18n.yaml, lib/review/idgxmlbuilder.rb,
+	  lib/review/topbuilder.rb: show only counter on
+	  image/list/table caption, if chapter number is
+	  undefined.
+
+Sat Jan 14 22:33:04 2012  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/tocparser.rb: remove BOM (\xEF\xBB\xBF) from
+	  line head to avoid review-index error. Closes #72.
+
+Sat Jan 14 22:02:29 2012  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/compiler.rb, lib/review/preprocessor.rb,
+	  test/test_preprocessor.rb: fix difference of line#
+	  between error output and source file which has comments.
+	  Closes #73.
+
+Mon Jan  2 01:09:58 2012  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/idgxmlbuilder: put <listinfo> to codelist element
+	  (//list) as same as list (//emlist).
+
+Fri Dec 16 01:01:31 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/latexbuilder.rb: LATEXBuilder: fix dlist(dd) bug
+
+Sat Nov 12 18:42:24 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-pdfmaker:
+	  LATEXBuilder: appendix and backmatter should be able to redefine
+
+Fri Nov 11 02:45:50 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/latexbuilder.rb:
+	  LATEXBuilder: use \url instead of \href if label is empty
+
+Sat Nov  5 15:37:58 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-epubmaker, bin/review-pdfmaker:
+	  fixes #50; make name of files generated in review-{epub|pdf}maker same as source filenames
+
+Fri Nov  4 22:39:23 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-pdfmaker:
+	  Force to execute platex command 3 times.
+	  Executing only 2 times, some documents convert into PDF with
+	  invalid page number :-(
+
+Thu Oct 27 16:30:08 2011  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/topbuilder.rb: trivial bug fixes around //raw.
+
+Sun Oct  9 00:43:51 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/latexbuilder.rb, lib/review/latexutils.rb:
+	  LATEXBuilder: fix escape in URL (use special method)
+
+Tue Sep 27 21:44:13 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-epubmaker: default author should be nil
+
+Tue Sep 27 21:36:00 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-epubmaker: fix Issue #43: fix generating invalid EPUB toc.html file
+
+Tue Sep 27 18:51:27 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/book.rb, bin/review-pdfmaker:
+	  support *.pdf file for images in LATEXBuilder
+
+Tue Sep 27 18:19:20 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-pdfmaker:
+	  support customizing coverfile in LATEXBuilder (same as HTMLBuilder)
+
+Fri Sep 23 22:06:26 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/latexutils.rb:
+          support MARUSUJI(number in circle) 0-10
+
+Wed Sep 21 19:51:57 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/compiler.rb: fix slow regexp (cf. [ruby-list:48379])
+
+Thu Sep 15 00:28:05 2011  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/builder.rb, lib/review/htmlbuilder.rb,
+	  lib/review/texbuilder.rb, lib/review/idgxmlbuilder.rb,
+	  test/test_htmlbuilder.rb, test/test_latexbuilder.rb,
+	  test/test_idgxmlbuilder.rb: handle metric parameter of
+	  //image and //indepimage more portable.
+	  Builder specific parameter can be specified with prefix
+	  html::, latex::, and idgxml::.
+
+Thu Sep  1 13:21:16 2011  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/htmlbuilder.rb: support --draft flag.
+	  add @<comment>. //comment and @<comment> will show in the
+	  output when --draft flag is specified. Without this flag
+	  (default), they will be converted to '<!-- -->'.
+
+Thu Sep  1 12:39:54 2011  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/htmlbuilder.rb: escape html in @<code>.
+
+Mon Aug 29 10:59:15 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-pdfmaker:
+	  add translater in okuduke and titlepage if values["trl"] has value
+	* bin/review-epubmaker:
+	  add translater in okuduke if values["trl"] has value
+
+Fri Aug 26 14:57:35 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-pdfmaker: fix some style broken in TeXLive 2011
+	* bin/review-pdfmaker: use extractbb instead of ebb
+
+Sat Aug 13 11:06:17 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-epubmaker:
+	  fix Issue #34: generating stylesheet with appropriate filename
+
+Sat Aug 11 01:23:00 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* test/test_latexbuilder.rb, lib/review/latexbuilder.rb:
+	  fix //noindent in LATEXBuilder
+
+Sat Jul  2 13:34:00 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/latexbuilder.rb, lib/review/compiler.rb, bin/review-compile:
+	  support //comment and @<comment> as PDF Annotation in LATEXBuilder
+
+Sat Jul  2 11:22:53 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-epubmaker, lib/review/htmlbuilder.rb:
+	  fix @<bib> and bib.re support in EPUB
+
+Sun Jun 26 22:38:09 2011  KADO Masanori  <kdmsnr@gmail.com>
+
+	* lib/review/builder.rb, lib/review/compiler.rb, lib/review/index.rb,
+	  lib/review/latexbuilder.rb, lib/review/idgxmlbuilder.rb, lib/review/htmlbuilder.rb:
+	  support //graph
+
+Thu Jun 16 15:59:35 2011  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/idgxmlbuilder.rb, test/test_idgxmlbuilder.rb:
+	  <td> has xyh attribution to point cell location and a number
+	  of header lines.
+
+Wed Jun  1 23:32:06 2011  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/idgxmlbuilder.rb: <recipe> uses full
+	  width blank instead of tab, because tab breaks
+	  a table element.
+
+Wed Jun  1 18:42:52 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* support caption as optional in //cmd{..} and
+	  //emlist{..}.
+
+Tue May 24 12:57:37 2011  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/idgxmlbuilder.rb: Use <lead> element for
+	  //lead and //read by default, to avoid nested <p>
+	  elements.
+
+Wed May 11 14:54:50 2011  Kenshi Muto  <kmuto@debian.org>
+
+	* merge Yutaka HARA's branch.
+	commit b4cf87a791f7dcca475cec9a5e838cc0da09de3b
+	Author: Yutaka HARA <yutaka.hara+github@gmail.com>
+	Date:   Wed May 11 14:28:41 2011 +0900
+
+	bin/review-vol: review-vol should accept --directory
+
+Mon Apr 25 07:22:39 2011  Kenshi Muto  <kmuto@debian.org>
+
+	* bin/review-compile, lib/review/htmlbuilder.rb:
+	  add --htmlversion option. This parameter takes the
+	  HTML version value 4 or 5.
+	* bin/review-epubmaker-ng: now works. It gets an ability to
+	  produce EPUB3 book.
+	* lib/epubmaker/epubv3.rb. lib/epubmaker/producer.rb: support
+	  EPUB3.
+	* lib/epubmaker/epubv2.rb: fix indents.
+
+Sat Apr 23 12:15:46 2011  Kenshi Muto  <kmuto@debian.org>
+
+	* Cherry-pick from Kouji Takao's branch.
+	commit 133c44c61da8b1057a6883e95a9165815f163cb4
+	Author: Kouji Takao <kouji@takao7.net>
+	Date:   Sun Jan 2 20:42:40 2011 +0900
+	
+	    display chapter name.
+	
+	commit 35b65a3e13463c54e696c71b6ec92d9c04a036df
+	Author: Kouji Takao <kouji@takao7.net>
+	Date:   Sun Jan 2 20:38:47 2011 +0900
+	
+	    supported book configuration in config.rb.
+	
+	commit 0c493c434bda7bc5b58d5927cc8caedb8da5105c
+	Author: Kouji Takao <kouji@takao7.net>
+	Date:   Sun Jan 2 20:37:56 2011 +0900
+	
+	    supported comment in CHAPS file.
+
+Mon Apr 11 18:41:26 2011  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-pdfmaker: add texdocumentclass option in config.yml
+
+Wed Mar 16 16:09:42 2011  Kenshi Muto  <kmuto@debian.org>
+
+	* Mege nari's branch.
+	  - use compile_inline() to caption on //bibpaper.
+
+Fri Feb 25 22:40:18 2011  Kenshi Muto  <kmuto@debian.org>
+
+	* Merge nari's branch.
+	  - add maxwidth for latex indepimage.
+
+Thu Feb  3 23:29:07 2011  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/book.rb, lib/review/index.rb: workaround for
+	  inline icon file support. (it still exports duplicate ID warning...)
+
+Sat Jan 29 23:03:37 2011  Kenshi Muto  <kmuto@debian.org>
+
+	* Merge nari's branch.
+	  - add @<bib> //bib to latexbuilder.
+
+Sat Jan 29 19:00:07 2011  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/epubmaker/epubv2.rb: add dc:publisher value in opf file
+	  (same value of prt).
+
+Wed Jan 12 23:49:05 2011  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/epubmaker/epubv2.rb: fix level handling of mytoc.
+
+Mon Dec 20 23:41:04 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/epubmaker/epubv2.rb: fix indent.
+	* test/test_epubmaker.rb: initial test codes.
+
+Mon Dec 20 00:12:41 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/epubmaker.rb: separate files to content, epubv2, epubv3,
+	  producer, and resource.
+
+Sat Dec 18 10:50:24 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* bin/review-compile, lib/review/htmlbuilder.rb,
+	  lib/review/idgxmlbuilder.rb: unify block coding styles and regexp
+	  coding styles.
+	* bin/review-compile: accept multiple stylesheets.
+	  set default values for language and htmlext.
+	  use YAML file by passing --yaml=YAMLFILE option.
+	* lib/review/htmlbuilder.rb: support htmlext and language parameter.
+	  support multiple stylesheets.
+	* lib/epubmaker.rb: new EPUB support library. Not only ReVIEW can
+	  use this library. This library is experimental.
+	* bin/review-epubmaker-ng: experimental alternative implementation
+	  for review-epubmaker using epubmaker.rb. This tools is under
+	  construction and may be changed widely.
+	* doc/libepubmaker/sample.yaml: sample YAML file for epubmaker.rb
+	  library.
+
+Sat Dec 12 09:30:28 2010  KADO Masanori  <kdmsnr@gmail.com>
+
+	* lib/review/compiler.rb: add [/column] notation
+	* test/test_htmlbuilder.rb, test/test_idgxmlbuilder.rb, test/test_latexbuilder.rb: add test for [/column] notation
+	* lib/review/tocparser.rb: ignore [/column] notation for review-index
+	* doc/format.rdoc: add [/column] notation
+
+Sat Dec 11 08:49:48 2010  KADO Masanori  <kdmsnr@gmail.com>
+
+	* bin/review-pdfmaker, lib/review/latexbuilder.rb: add maxwidth
+	for latex image
+	* bin/review-pdfmaker: include image subdir for ebb
+
+Sat Dec 11 02:39:37 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/htmlbuilder.rb: remove empty line after <pre> tag
+
+Thu Dec  9 11:15:11 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/compiler.rb: fix slow regexp for compiling inline
+	  (ex. '@<href>{http://very.long.name/and/missing/close/curly/brace')
+
+Sat Dec  4 00:18:45 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* doc/quickstart.rdoc: created.
+	* lib/review/textbuilder.rb: provide a wrapper of topbuilder.rb.
+	  'review-compile --target text' (or review2text) makes a plain
+	  text file with pseudo tags.
+
+Thu Dec  2 08:23:14 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/compiler.rb, lib/review/htmlbuilder.rb,
+	  lib/review/latexbuilder.rb: move core tag @<icon> to
+	  compiler.rb.
+	* lib/review/topbuilder.rb, test/test_topbuilder.rb: supports
+          same tags with other builders.
+
 Wed Dec  1 16:41:40 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
 
 	* VERSION: Version bump to 0.9.0

data/Rakefile

@@ -21,14 +21,12 @@ rescue LoadError
 end
 
 
-task :test => :check_dependencies
-
 task :default => [:test]
 
 Rake::TestTask.new("test") do |t|
-	t.libs   << "test"
-	t.pattern = "test/test_*.rb"
-	t.verbose = true
+  t.libs   << "test"
+  t.pattern = "test/test_*.rb"
+  t.verbose = true
 end
 
 begin

data/VERSION

@@ -1 +1 @@
-0.9.0
+1.0.0

data/bin/review-compile

@@ -15,6 +15,7 @@ require 'pathname'
 bindir = Pathname.new(__FILE__).realpath.dirname
 $LOAD_PATH.unshift((bindir + '../lib').realpath)
 
+require 'review'
 require 'review/compiler'
 require 'review/book'
 require 'fileutils'
@@ -48,70 +49,62 @@ def _main
     "inencoding" => "UTF-8",
     "outencoding" => "UTF-8",
     "subdirmode" => nil,
-    "stylesheet" => nil,  # for HTML
+    "singledirmode" => nil,
+    "stylesheet" => [],   # for HTML
     "mathml" => nil,      # for HTML
+    "language" => "ja",   # for HTML
     "deprecated-blocklines" => nil,
+    "footnotetext" => false,
+    "htmlext" => "html",
+    "htmlversion" => 4,
   }
 
   parser = OptionParser.new
   parser.banner = "Usage: #{File.basename($0)} [--target=FMT]"
-  parser.on('--inencoding=ENCODING', 'Set input encoding. (UTF-8, EUC, JIS, and SJIS)') {|enc|
-    param["inencoding"] = enc
-  }
-  parser.on('--outencoding=ENCODING', 'Set output encoding. (UTF-8[default], EUC, JIS, and SJIS)') {|enc|
-    param["outencoding"] = enc
-  }
-  parser.on('-c', '--check', 'Check manuscript') {
-    check_only = true
-  }
-  parser.on('--level=LVL', 'Section level to append number.') {|lvl|
-    param["secnolevel"] = lvl.to_i
-  }
-  parser.on('--nolfinxml', 'Do not insert LF in XML. (idgxml)') {
-    param["nolf"] = true
-  }
-  parser.on('--table=WIDTH', 'Default table width. (idgxml)') {|tbl|
-    param["tableopt"] = tbl
-  }
-  parser.on('--listinfo', 'Append listinfo tag to lists to indicate begin/end. (idgxml)') {
-    param["listinfo"] = true
-  }
-  parser.on('--chapref="before,middle,after"', 'Chapref decoration.') {|cdec|
-    param["chapref"] = cdec
-  }
-  parser.on('--subdirmode', 'Use chapter/id.ext path style to find images.') {
-    param["subdirmode"] = true
-  }
-  parser.on('--stylesheet=file', 'Stylesheet file for HTML') {|file|
-    param["stylesheet"] = file
-  }
-  parser.on('--mathml', 'Use MathML for TeX equation in HTML') {
+  parser.on('--yaml=YAML', 'Read configurations from YAML file.') do |yaml|
+    require 'yaml'
+    param = param.merge(YAML.load_file(yaml))
+  end
+  parser.on('--inencoding=ENCODING', 'Set input encoding. (UTF-8, EUC, JIS, and SJIS)') {|enc| param["inencoding"] = enc }
+  parser.on('--outencoding=ENCODING', 'Set output encoding. (UTF-8[default], EUC, JIS, and SJIS)') {|enc| param["outencoding"] = enc }
+  parser.on('-c', '--check', 'Check manuscript') { check_only = true }
+  parser.on('--level=LVL', 'Section level to append number.') {|lvl| param["secnolevel"] = lvl.to_i }
+  parser.on('--nolfinxml', 'Do not insert LF in XML. (idgxml)') { param["nolf"] = true }
+  parser.on('--table=WIDTH', 'Default table width. (idgxml)') {|tbl| param["tableopt"] = tbl }
+  parser.on('--listinfo', 'Append listinfo tag to lists to indicate begin/end. (idgxml)') { param["listinfo"] = true }
+  parser.on('--chapref="before,middle,after"', 'Chapref decoration.') {|cdec| param["chapref"] = cdec }
+  parser.on('--subdirmode', 'Use chapter/id.ext path style to find images.') { param["subdirmode"] = true }
+  parser.on('--singledirmode', 'Use id.ext path style to find images.') { param["singledirmode"] = true }
+  parser.on('--chapterlink', 'make chapref hyperlink') { param["chapterlink"] = true }
+  parser.on('--stylesheet=file', 'Stylesheet file for HTML (comma separated)') {|files| param["stylesheet"] = files.split(/\s*,\s*/) }
+  parser.on('--mathml', 'Use MathML for TeX equation in HTML') do
     param["mathml"] = true
     require 'math_ml'
-  }
-  parser.on('--hdnumberingmode', 'Output numbering headlines. (deprecated)') {
-    param["hdnumberingmode"] = true
-  }
-  parser.on('--deprecated-blocklines', 'Disable paragrahs in block tags. Treat physical line as a paragraph. (deprecated)') {
-    param["deprecated-blocklines"] = true
-  }
-  unless target
-    parser.on('--target=FMT', 'Target format.') {|fmt|
-      target = fmt
-    }
   end
-  parser.on('-a', '--all', 'Compile all chapters.') {
+  parser.on('--htmlversion=VERSION', 'HTML version.') do |v|
+    v = v.to_i
+    param["htmlversion"] = v if v == 4 || v == 5
+  end
+  parser.on('--hdnumberingmode', 'Output numbering headlines. (deprecated)') { param["hdnumberingmode"] = true }
+  parser.on('--deprecated-blocklines', 'Disable paragrahs in block tags. Treat physical line as a paragraph. (deprecated)') { param["deprecated-blocklines"] = true }
+  parser.on('--target=FMT', 'Target format.') {|fmt| target = fmt } unless target
+  parser.on('--footnotetext',
+            'Use footnotetext and footnotemark instead of footnote (latex)') {
+    param["footnotetext"] = true
+  }
+  parser.on('--draft', 'use draft mode(inline comment)') { param["draft"] = true }
+  parser.on('-a', '--all', 'Compile all chapters.') do
     mode = :dir
     basedir = nil
-  }
-  parser.on('--directory=DIR', 'Compile all chapters in DIR.') {|path|
+  end
+  parser.on('--directory=DIR', 'Compile all chapters in DIR.') do |path|
     mode = :dir
     basedir = path
-  }
-  parser.on('--help', 'Prints this message and quit.') {
+  end
+  parser.on('--help', 'Prints this message and quit.') do
     puts parser.help
     exit 0
-  }
+  end
   begin
     parser.parse!
     unless target
@@ -127,6 +120,13 @@ def _main
     exit 1
   end
 
+  # array parameter
+  ["stylesheet"].each do |k|
+    if param["k"].instance_of?(String)
+      param["k"] = [param["k"]]
+    end
+  end
+
   begin
     compiler = ReVIEW::Compiler.new(load_strategy_class(target, check_only))
     ReVIEW.book.param = param
@@ -138,7 +138,7 @@ def _main
       end
       ReVIEW::Chapter.intern_pathes(ARGV).each do |chap|
         result = compiler.compile(chap)
-        print result unless check_only
+        puts result unless check_only
       end
     when :dir
       book = basedir ? ReVIEW::Book.load(basedir) : ReVIEW.book