review 0.6.0 → 0.9.0

data/ChangeLog

@@ -1,3 +1,444 @@
+Wed Dec  1 16:41:40 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* VERSION: Version bump to 0.9.0
+
+Wed Dec  1 16:38:34 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* doc/format.txt, doc/format_idg.txt, doc/format_sjis.txt, doc/memo-reviewspec.txt:
+	  delete old docs; see format.rdoc, format_idg.rdoc and
+	  Wiki pages on github.com (https://github.com/kmuto/review/wiki)
+
+Sun Nov 28 14:12:50 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/idgxmlbuilder.rb: partially support for metric.
+	* test/test_htmlbuilder.rb, test/idg_xmlbuilder.rb,
+	  test/test_latexbuilder.rb: add test for //indepimage and //image.
+
+Sun Nov 28 01:28:06 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/latexbuilder.rb, lib/review/idgxmlbuilder.rb,
+	  lib/review/htmlbuilder.rb, lib/review/builder.rb:
+	   - support metric option of //image
+
+Sat Nov 27 22:59:24 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/compiler.rb: accept space/tab before :
+	  (description list).
+
+Sat Nov 27 22:27:56 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/htmlbuilder.rb: use <p class="noindent"> for
+	  //noindent. use <p class="flushright"> for //flushright (for
+	  backward compatibility, it can be reverted to older <div> and
+	  <pre> style by setting --deprecated-blocklines.)
+	* test/test_latexbuilder.rb, test/test_htmlbuilder.rb,
+	  test/test_idgbuilder.rb: add flushright and noindent tests.
+	* doc/sample.css: add p, p.noindent, p.flushright, and p.caption.
+
+Sat Nov 27 22:00:20 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* bin/review-index: deprecate --html option.
+	* bin/review-check: deprecate -s option.
+	* bin/review-preproc: deprecate --final option.
+
+Sat Nov 27 21:40:42 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* merge kdmsnr's branch.
+	  - add inline_table/list ref to another chapter.
+
+Sat Nov 27 14:58:05 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* Clean up.
+	  - bin/setup.rb: remove obsolete file. use gem or git.
+	  - lib/review/book.rb, test/test_book.rb: remove PARAMS.
+	  - lib/review/compiler.rb, lib/review/htmlbuilder.rb,
+	    lib/review/idgxmlbuilder.rb, lib/review/latexbuilder.rb:
+	    support caption in //indepimage.
+	    //numberlessimage aliases of //indepimage.
+	  - bin/review-compile, lib/review/compiler.rb: --hdnumberingmode
+	    is deprecated. use --level option.
+	  - lib/review/book.rb: remove nocode_file and index_file because
+	    they aren't used anymore.
+	  - bin/review-epubmaker: print usage if argument isn't defined.
+
+Sat Nov 27 04:00:01 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-pdfmaker: make default LaTeX style much simpler.
+	  - add \reviewmainfont and \reviewtitlefont (you can redifine with \renewcomamnd{})
+	  - delete header/footer definition (you can do it with config.yml)
+
+Mon Nov 22 00:44:20 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/latexbuilder.rb: support @<icon>{} in LATEXBuilder
+
+Sun Nov 21 21:50:32 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* test/test_uuid.rb: reduce slow tests. If we use original
+	  uuid.rb without any changes, it's no problem.
+
+Sun Nov 21 15:02:00 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/book.rb: add 'ai' to acceptable image file.
+	* lib/review/builder.rb: move find_pathes() and entries() here
+	  from HTMLBuilder.
+	* lib/review/compiler.rb: rescue string() error for TestUnit.
+	* lib/review/htmlbuilder.rb: cleanup.
+	* lib/review/idgxmlbuilder.rb: support both 1.8 and 1.9 in
+	  inline_maru. use find_pathes() of builder for @icon and
+	  //indepimage.
+
+Sun Nov 21 14:22:55 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/idgxmlbuilder.rb, test/test_idgxmlbuilder.rb:
+	  refactoring. add some tests.
+
+Wed Nov 17 09:36:50 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* merge KADO's patch and modify.
+	  - lib/review/idgxmlbuilder.rb, lib/review/htmlbuilder.rb,
+	    lib/review/latexbuilder.rb: //lead, //read, //quote, //note,
+	    //memo, //tip, //info, //planning, //best, //important,
+	    //security, //caution, //term, //link, //notice, //point,
+	    //shoot, //reference, //practice: use normal paragraph
+	    syntax; splitted by empty line.
+	  - bin/review-compile: For backward compatibilty, add
+	    --deprecated-blocklines option.
+
+Wed Nov 17 17:55:42 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/latexutils.rb, bin/review-pdfmaker,
+	  test/test_latexbuilder.rb:
+	  - \textbackslash -> \reviewbackslash(to replace into yensign) in LATEXBuilder
+          - allow to overwrite review* macro in LATEXBuilder
+
+Sat Nov 13 23:19:25 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* test/test_builder.rb, test/test_htmlbuilder.rb,
+	  test/test_idgxmlbuilder.rb, test/test_latexbuilder.rb:
+	  add some block test codes.
+	* Fix //quote handling of LATEXBuilder.
+
+Sun Nov 14 05:19:53 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* merge KADO's patch.
+	  - test/test_latexbuilder.rb, lib/review/latexbuilder.rb:
+	    //quote allow newlines in LATEXBuilder.
+
+Sat Nov 13 10:33:13 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/idgxmlbuilder.rb: round float value for
+	  the compatibility between 1.8 and 1.9.
+
+Thu Nov 11 08:16:10 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* test/test_latexbuilder.rb: test tagged header.
+
+Thu Nov 11 21:34:39 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/compiler.rb, lib/review/htmlbuilder.rb,
+	  lib/review/idgxmlbuilder.rb, lib/review/latexbuilder.rb:
+	  allow inline tags in captions and headers.
+	* test/test_htmlbuilder.rb: test tagged header.
+
+Mon Nov  8 21:58:27 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* merge KADO's patch.
+	- lib/review/htmlbuilder.rb: add chap to tabel_header.
+
+Mon Nov  8 21:51:43 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/compiler.rb, lib/review/htmlbuilder.rb,
+	  lib/review/idgxmlbuilder.rb, lib/review/latexbuilder.rb:
+	  move @<tti>, @<ttb>, @<u>, @<uchar>, @<idx>, and @<hidx> to
+	  base op.
+	* lib/review/htmlbuilder.rb, lib/review/latexbuilder.rb:
+	  support @<uchar> op.
+	* test/test_htmlbuilder.rb, test/test_latexbuilder.rb,
+	  test/test_idgxmlbuilder.rb: add test for @<uchar>.
+
+Sun Nov  7 17:23:12 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/latexbuilder.rb: support //indepimage.
+	* lib/review/htmlbuilder.rb, lib/review/idgxmlbuilder.rb: accept
+	  (though just ignore) metric option of //indepimage.
+
+Sun Nov  7 15:20:16 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/htmlbuilder.rb: use <u> instead of <underline> for underline.
+
+Sun Nov  7 13:20:37 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/latexbuilder.rb: support @<tti> and @<ttb> for LATEXBuilder
+
+Sun Nov  7 12:35:11 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/idgxmlbuilder.rb: ad-hoc support for //texequation
+	  and @<m>.
+
+Sun Nov  7 12:01:03 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* merge KADO's branch.
+	 - lib/review/htmlbuilder.rb, lib/review/idgxmlbuilder.rb:
+	   add @ttb op.
+
+Thu Nov  4 20:48:41 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-pdfmaker: update colophon in LATEXBuilder.
+
+Thu Nov  4 19:58:20 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-pdfmaker, lib/review/latexbuilder.rb:
+	  use \reviewkw{} for @<kw>, and \reviewkw{} use \textbf{}
+	  and \textgt{} as default
+
+Thu Nov  4 17:29:17 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-pdfmaker: only use coverimage file if 'converimage'
+	  attributes has a value(but ignore coverfile).
+
+Thu Nov  4 17:11:56 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* test/test_htmlbuilder.rb, test/test_latexbuilder.rb:
+	  add some inline tests.
+
+Thu Nov  4 17:11:04 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/latexbuilder.rb: escape inline_m's content.
+
+Thu Nov  4 07:27:09 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* bin/review-compile, lib/review/compiler.rb,
+	  lib/review/htmlbuilder.rb, lib/review/htmlutils.rb,
+	  lib/review/latexbuilder.rb, lib/review/latexutils.rb,
+	  doc/format.rdoc, doc/format.re, doc/format.txt:
+	  add experimental TeX block equation/inline equation support.
+	  add //texequation in LATEXBuilder and HTMLBuilder.
+	  add @<m> op in HTMLBuilder.
+	  add --mathml option to use math_ml.rb library
+	  (http://www.hinet.mydns.jp/?mathml.rb) in HTMLBuilder.
+
+Wed Nov  3 23:44:37 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* merge KADO's branch.
+	- bin/review-index: add chapter option
+
+Tue Nov  2 19:11:51 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* merge KADO's branch.
+	- lib/review/htmlbuilder.rb: add chap to image_header
+	- doc/format.rdoc: initial document file for GitHub.
+
+Fri Oct 29 06:23:56 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/uuid.rb, test/test_uuid.rb, doc/ruby-uuid/README,
+	  doc/ruby-uuid/README.ja: uuid library, imported from
+	  git://github.com/shyouhei/ruby-uuid.git
+	  Copyright 2007 URABE, Shyouhei.
+	  (At this time, I prefer to import third party libraries
+	  rather than using gems, to let ReVIEW work on essential
+	  Ruby environments.)
+	* bin/review-epubmaker: use time-based random urnid when
+	  urnid isn't defined.
+	  write <itemref idref="toc" /> only if mytoc is defined.
+	* doc/sample.yaml: modify descriptions of urnid, stylesheet,
+	  colophon, and debug.
+
+Wed Oct 27 02:39:40 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/latexbuilder.rb: do not use \begin{table}...\end{table}
+	  if caption is empty (because we cannot use {table} in column section)
+
+Tue Oct 26 12:26:01 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-pdfmaker: fix all characters in rightside header are uppercase.
+
+Sun Oct 24 04:26:54 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-pdfmaker, lib/review/latexbuilder.rb:
+	  fix caption of //list and //table in LATEXBuilder
+
+Tue Oct 19 15:48:44 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/latexbuilder.rb: add //tsize and //latextsize for table in LATEXBuilder
+
+Tue Oct 19 12:54:40 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/latexbuilder.rb: not use shortstack without @<br>
+
+Sun Oct 17 01:03:43 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-pdfmaker: LATEXBuilder supports //memo command
+
+Wed Oct 13 21:03:25 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/compiler.rb: drop support for multichoice
+	  and singlechoice. They need more sophisticated symbols
+	  (don't use misleading multibyte characters).
+
+Wed Oct 13 20:54:39 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* support ruby 1.9.
+
+Sat Sep 11 19:15:59 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/book.rb, lib/review/htmlbuilder.rb,
+	  lib/review/index.rb: support //indepimage.
+
+Sat Sep 11 18:29:39 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* bin/review-compile, bin/review-vol, lib/review/book.rb,
+	  lib/review/compiler.rb, lib/review/htmlbuilder.rb,
+	  lib/review/idgxmlbuilder.rb, lib/review/index.rb,
+	  lib/review/latexbuilder.rb, test/*.rb:
+	  manage parameters by ReVIEW.book.param.
+	* bin/review-preproc, lib/review/preprocessor.rb:
+	  manage preprocessor parameters by Preprocessor.param.
+	* lib/review/buildedr.rb: handle encoding conversions by
+	  Builder#convert_outencoding.
+
+Sat Sep 11 16:28:32 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/latexbuilder.rb, lib/review/htmlbuilder.rb:
+	  support [nonum] in headlines.
+
+Fri Sep 10 19:33:27 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/htmlbuilder.rb, test/test_htmlbuilder.rb: 
+	  revert to use double quote for element attributes.
+
+Thu Sep  9 22:21:22 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/htmlbuilder.rb: 
+	  - use single quote for element attributes.
+	  - use 'caption' for the class name of all captions.
+	  - surround //source by div class='source-code' instead of
+	    div class='caption-code'.
+	  - surround //emlist and //emlistnum by div class='emlist-code'
+	    instead of div class='code'.
+	  - surround //cmd by div class='cmd-code' instead of div
+	    class='code'.
+	  - surround table by div class='table'.
+	  - use b (bold) for @<kw> instead of span class='kw'.
+	  - use tt (typewriter) for @<code> instead of span
+	    class='inline-code'.
+	* test/test_htmlbuilder.rb: follow single quote changes.
+
+Wed Sep  8 22:24:49 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/htmlbuilder.rb: import all of epubbuilder.rb.
+	  - CSS name changed.
+	    //list caption: toplabel -> listcaption
+	    //source caption: toplabel -> sourcecaption
+	    //image caption: botlabel -> imagecaption
+	    //table caption: toplabel -> tablecaption
+          - //comment is converted as <!-- --> instead of <p class="comment">.
+	  - //image and //numberlessimage are converted as
+	    <div class="image"><img> instead of <p class="img"><img>
+	  - Produce XHTML header/footer contents by default.
+	  - Insert orderded numbers in headers by default. Specifing
+	    --secnolevel=0 prevents all of them.
+	* bin/review-compile, doc/memo-reviewspec.txt, bin/review-epubmaker:
+	  Replace string EPUB with HTML to follow HTMLBuilder changes.
+
+Sat Sep  4 11:53:31 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/latexbuilder.rb: add bloks: emlistnum, listnum, reviewlistcaption, source, flushright
+
+Sat Sep  4 11:45:36 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/latexbuilder.rb: add inlines: @<i>,@<idx>,@<hidx>,@<dtp>,@<code>,
+	  @<hd_chap>,@<raw>,@<sub>,@<sup>,@<em>,@<strong>,@<u>
+
+Fri Sep  3 22:50:56 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-pdfmaker: make background color of //cmd black
+
+Fri Sep  3 01:01:19 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/latexbuilder.rb, bin/review-pdfmaker: use {alltt}
+	  instead of {verbatim} to allow inline in lists and cmds.
+
+Thu Sep  2 23:38:01 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* bin/review-pdfmaker: add command bin/review-pdfmaker for generating PDF document by LaTeX
+
+Thu Sep  2 13:24:24 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/latexbuilder.rb, test/test_latexbuilder.rb: add op @<br>{} into LaTeXBuilder.
+
+Thu Sep  2 12:05:58 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* add op @<br>{}.
+
+Wed Sep  1 14:43:13 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* Merge git://github.com/akira/review. 52db533ba53a8d9416a17773fdfcf97044f858f0
+	  - added tests for ReVIEW.book
+	  - added tests for ReVIEW::Parameters
+	  - moved get_instance_variables to the Helper module
+	  - added tests for ReVIEW::Book.{load,load_default}
+	  - added tests for ReVIEW::Book.update_rubyenv
+	  - added tests for ReVIEW::ChapterSet
+	  - added tests for ReVIEW::Chapter.intern_pathes
+	  - added tests for index methods of ReVIEW::Chapter
+	  - added tests for ReVIEW::Chapter#on_CHAPS?
+	  - added tests for ReVIEW::Part
+	  - added/modifed ext of contents of CHAPS/PREDEF
+            Can we omit ext of files?
+	  - added a test for ReVIEW::Book#volume
+	  - added a test for ReVIEW::Book#{chapters,chapter,each_chapter}
+	  - added a test for ReVIEW::Book#{part,each_part}
+	  - added a test for ReVIEW::Book#parts
+	  - added a test for ReVIEW::Book#basedir
+	  - added tests for ReVIEW::Book#postscripts
+	  - added tests for ReVIEW::Book#prefaces
+	  - added tests for ReVIEW::Book#{setParameter,parse_chapters}
+	  - added tests for ReVIEW::Book#read_{CHPAS,PART,bib}
+	  - added a test for Book.load_default
+	  - added a test for ReVIEW::Chapter#volume
+	  - added some tests for ReVIEW::Chapter
+	  - added some tests for Builder
+	  - added test for ReVIEW::HTMLUtils
+	  - removed unused setup
+	  - added tests for LineInput
+	  - added rcov task
+
+Sun Aug 22 23:25:44 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* Merge git://github.com/moro/review into moro
+	  - map* from git blob object
+	    with @mapfile(git|<object-spec>).example:
+	      #@mapfile(git|2e725159:src/codes/features/signup_and_login.feature)
+
+Sun Aug 22 23:08:59 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/epubbuilder.rb: remove escape_html from table to
+	  avoid double escaping. add @<dtp> op.
+	* test/test_epubbuilder.rb: add test for table to avoid double
+	  escaping.
+	* test/test_idgxmlbuilder.rb: add test unit for IDGXML builder.
+
+Fri Aug 20 14:20:03 2010  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* doc/memo-reviewspec.txt: add document for design of review format.
+
+Sun Aug  8 17:18:03 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* Merge nari's branch. 27a35652ecb5a94d5b36
+	  - lib/review/htmlbuilder.rb: add @<doorquote>, @<talk>
+	  - lib/review/htmlbuilder.rb: support @<href>.
+	  - lib/review/builder.rb: move param parameter to global.
+	  - lib/review/compiler.rb: replace @@hdnumberingmode by @strategy.param.
+	* lib/review/epubbuilder.rb: add @<doorquote>, @<talk>, @<hd_chap>.
+	* lib/review/compiler.rb, lib/review/index.rb: unify coding styles.
+	  fix a typo.
+
+Sun Aug  8 17:01:48 2010  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/compiler.rb, lib/review/epubbuilder.rb: support //box
+	  as global environment.
+	* lib/review/epubbuilder.rb: support @<icon>.
+
 Mon Jul  5 14:42:49 2010  Kenshi Muto  <kmuto@debian.org>
 
 	* lib/review/idgxmlbuilder.rb, lib/review/epubbuilder.rb:

data/README.rdoc

@@ -2,6 +2,31 @@
 
 ReVIEW is a easy-to-use digital publishing system for books and ebooks.
 
+== Format
+
+ReVIEW uses its original format('ReVIEW format') as source files. See doc/format.rdoc (in Japanese).
+
+Output formats ReVIEW supports are:
+
+* EPUB
+* LaTeX(ptexlive)
+* InDesign(IDGXML)
+* plain text(TOPBuilder Markup Lang.)
+
+== Commands
+
+There are two commands generate files directly.
+
+* review-epubmaker: generate EPUB file.
+* review-pdfmaker: generate PDF file using LaTeX(ptexlive).
+
+And some useful commands.
+
+* review-compile: compile ReVIEW fomat files.
+* review-vol: figure out size of ReVIEW files.
+* review-index: generate index with various format.
+* review-preproc: preprocessor.
+
 == Note on Patches/Pull Requests
  
 * Fork the project.