review 0.6.0 → 0.9.0

data/doc/format.re

@@ -317,6 +317,7 @@ RD や各種 Wiki の文法をとりいれて簡素化しています。
 
 リード文は //read{ 〜 //} で指定します。lead でなく read
 なのは、ASCII の EWB が「read」を使っていたからです。
+//lead{ 〜 //} でも使えます。
 
 === [例]
 
@@ -327,6 +328,18 @@ RD や各種 Wiki の文法をとりいれて簡素化しています。
   //}
 //}
 
+== TeX式
+
+LaTeX の式を挿入するには、//texequation{ 〜 //} を使います。
+
+=== [例]
+
+//emlist{
+  //texequation{
+  \sum_{i=1}^nf_n(x)
+  //}
+//}
+
 == 空白制御
 
 : //noindent
@@ -398,6 +411,12 @@ ReVIEW は任意のブロックを追加可能なので、本によって専用
 : @<raw>{@<b>{どうしても\}}
     太字。
 
+: @<raw>{@<br>{\}}
+    段落中改行。
+
+: @<raw>{@<m>{a + \alpha\}}
+    TeXインライン式。
+
 == 著者用タグ (プリプロセッサ命令)
 
 これまでに説明したタグはすべて最終段階まで残り、見ために

data/doc/format_idg.rdoc

@@ -0,0 +1,180 @@
+= ReVIEW フォーマット InDesign XML 形式拡張
+
+ReVIEW フォーマットから、Adobe 社の DTP ソフトウェア「InDesign」
+で読み込んで利用しやすい XML 形式に変換できます (通常の XML とほぼ同じ
+ですが、文書構造ではなく見た目を指向した形態になっています)。
+現時点では idgxmlbuilder.rb と topbuilder.rb のみが拡張に対応しています。
+実際には出力された XML を InDesign のスタイルに割り当てるフィルタをさらに
+作成・適用する必要があります。
+
+== 章・節・項・段
+
+従来の[column]のほかに、オプションを追加しています。
+
+* [nonum] : これを指定している章・節・項・段には連番を振りません。
+* [circle]: 「・」を先頭に付けた小さな見出し(連番なし)を作成します。
+* [world]: Real Worldコラム。
+* [hood]: Under the Hoodコラム。
+* [edition]: Editionコラム。
+* [insideout]: インサイドアウトコラム。
+
+== 書式ブロック
+//insn[タイトル]{ 〜 //} または //box[タイトル]{ 〜 //} で書式を指定し
+ます。
+
+== ノート
+//note{ 〜 //} または //note[タイトル]{ 〜 //} で注意文章を指定します。
+
+== メモ
+//memo{ 〜 //} または //memo[タイトル]{ 〜 //} でメモ文章を指定します。
+
+== ヒント
+//tip{ 〜 //} または //tip[タイトル]{ 〜 //} でヒント(Tip)文章を指定します。
+
+== 参照ブロック
+//info{ 〜 //} または //info[タイトル]{ 〜 //} で参照文章を指定します。
+
+== プランニング
+//planning{ 〜 //} または //planning[タイトル]{ 〜 //} でプランニング文章を
+指定します。
+
+== ベストプラクティス
+//best{ 〜 //} または //best[タイトル]{ 〜 //} でベストプラクティス文章を
+指定します。
+
+== ここが重要 (キーワード)
+//important[タイトル]{ 〜 //} で重要項目を指定します。
+
+== セキュリティ
+//security{ 〜 //} または //security[タイトル]{ 〜 //} でセキュリティ文章を
+指定します。
+
+== 警告
+//caution{ 〜 //} または //caution[タイトル]{ 〜 //} で警告文章を指定します。
+
+== エキスパートに訊く
+//expert{ 〜 //} で「エキスパートに訊く」を指定します (rawで<expert>〜
+</expert>を使うほうがよいかもしれません)。
+QとAは@<b>{Q}：〜 と @<b>{A}：〜 で示します。
+
+== 注意
+//notice{ 〜 //} または //notice[タイトル]{ 〜 //} で注意を指定します。
+
+== ワンポイント
+//point{ 〜 //} または //point[タイトル]{ 〜 //} でワンポイントを指定します。
+
+== トラブルシューティング
+//shoot{ 〜 //} または //shoot[タイトル]{ 〜 //} でトラブルシューティングを
+指定します。
+
+== 用語解説
+//term{ 〜 //} で用語解説を指定します(ただし、ブロック指定ができないので
+実質的にはrawで<term>〜</term>を通常使うことになるでしょう)。
+
+== リンク
+//link{ 〜 //} または //link[タイトル]{ 〜 //} で他の章やファイルなどへの
+参照内容を指定します。
+
+== 練習問題
+//practice{ 〜 //} で練習問題を指定します。
+
+== 参考
+//reference{ 〜 //} で参考情報を指定します。
+
+== 相互参照
+//label[〜]でラベルを定義し、@<labelref>{〜}で参照します。
+XMLとしては<label id='〜' />と<labelref idref='〜' />というタグに
+置き換えられます。
+実際にどのような相互参照関係にするかは、処理系に依存します。
+想定の用途では、章や節の番号およびタイトルを記憶し、labelrefの出現箇所
+に"「節(あるいは章)番号　タイトル」"という文字列を配置します。
+
+@<chapref>の展開形式を、--chapref="前装飾文字列,中間装飾文字列,後装飾文字列"
+でコンパイル実行時に指定できます。デフォルトは",「,」"です。たとえば
+"第2章「コンパイラ」" のように普通は展開されます。
+"「,　,」"と指定すると、"「第2章　コンパイラ」" に展開されます。
+
+== 丸数字
+@<maru>{数値} で丸数字を出力します。
+
+== キートップ
+@<keytop>{キー文字} でキーボードマークを出力します。
+
+== 吹き出し
+@<balloon>{〜} でコード内などでの吹き出しを作成します。吹き出しは右に寄せ
+られ、記入した箇所から吹き出しまで線が引かれます。
+@<>オペレータは入れ子ができないため、丸数字を使いたいときには@maru[数値]
+という特別な書式を代わりに使います。
+
+== ロー指定
+現時点で ReVIEW はブロックの入れ子処理ができないため、ロー指定で XML
+エレメントを指定しなければならないこともあります。
+
+インラインの@<raw>{ 〜 }の他に、単一行の//raw[〜]、ブロック版の //rawblock{ 〜 //} でも、フォーマット処理をせずにそのままの文字列が出力できます。
+
+== キャプションなし表
+//table{ 〜 //} のように id もキャプションも付けないブロックを利用できます。
+この場合、その表の連番付けを飛ばします。
+
+== 表セル幅の指定
+//tsize[1列目の幅,2列目の幅,...] で、続く //table の表の列幅を指定します
+(単位mm)。これを利用するときには、review2idgxml を実行する際、オプション
+--table=表幅 を付ける必要があります (表幅の単位は mm)。列幅指定の個数が
+実際の列数に満たない場合、残りの列は均等分割したものとなります。列幅の
+合計が表幅を超えるとエラーになります。
+
+== DTP 命令指定
+@<dtp>{ 〜 } で InDesign 向けに「<? dtp 〜 ?>」型の XML インストラクション
+を埋め込みます。処理系に渡す任意の文字列を指定できますが、次のような文字列
+を特殊文字指定できます。
+
+* maru	番号リストの各段落先頭で使い、このリスト段落の番号は丸数字であることを示す
+* return  改行記号文字
+
+* autopagenumber	現ページ番号
+* nextpageunmber	次ページ番号
+* previouspagenumber	前ページ番号
+* sectionmarker	セクションマーカー
+* bulletcharacter	ビュレット (ナカグロ)
+* copyrightsymbol	著作権記号
+* degreesymbol	度記号
+* ellipsischaracter	省略記号
+* forcedlinebreak	強制改行
+* discretionarylinebreak	任意の改行
+* paragraphsymbol	段落記号
+* registeredtrademark	登録商標記号
+* sectionsymbol	セクション記号
+* trademarksymbol	商標記号
+* rightindenttab	右インデントタブ
+* indentheretab	「ここまでインデント」タブ
+* zerowidthnonjoiner	結合なし
+* emdash	EMダッシュ
+* endash	ENダッシュ
+* discretionaryhyphen	任意ハイフン
+* nonbreakinghyphen	分散禁止ハイフン
+* endnestedstyle	先頭文字スタイルの終了文字
+* doubleleftquote	左二重引用符
+* doublerightquote	右二重引用符
+* singleleftquote	左用符
+* singlerightquote	右引用符
+* singlestraightquote	半角一重左用符
+* doublestraightquote	半角二重引用符
+* emspace	EMスペース
+* enspace	ENスペース
+* flushspace	フラッシュスペース
+* hairspace	極細スペース
+* nonbreakingspace	分散禁止スペース
+* fixedwidthnonbreakingspace	分散禁止スペース（固定幅）
+* textvariable	全角スペース
+* thinspace	細いスペース
+* figurespace	数字の間隔
+* punctuationspace	句読点等の間隔
+* sixthspace	1/6スペース
+* quarterspace	1/4スペース
+* thirdspace	1/3スペース
+* columnbreak	改段
+* framebreak	改フレーム
+* pagebreak	改ページ
+* oddpagebreak	奇数改ページ
+* evenpagebreak	偶数改ページ
+* footnotesymbol	脚注記号

data/doc/ruby-uuid/README

@@ -0,0 +1,11 @@
+For GitHub users;
+
+This is  a pure-ruby  implementation of RFC4122  that I wrote  back in
+2005.  I have touched its  internals a few times (mainly bugfixes).  I
+know someone  has already uploaded  an old copy  of it to  GitHub, and
+thats' 100% legal he has the right to do so, but I believe what I have
+now is better than the older ones.  So I upload this.
+
+It's  very  tiny  (<300 lines  ruby  code)  and  you can  simply  copy
+lib/uuid.rb to your  project.  The gemspec file can  help you maintain
+your dependency though.

data/doc/ruby-uuid/README.ja

@@ -0,0 +1,34 @@
+UUID: Pure-ruby RFC4122 Implementation
+
+RFC4122をフルサポート(はず)のライブラリ。使いかたは
+
+require 'uuid'
+UUID.create # => instance
+
+とか。
+
+基本的にUUIDってのは存在していることに意味があるオブジェクトなため、それ自身には
+ほとんどインスタンスメソッドを持たない。以下はその数少ないメソッドたち
+
+* UUID#==, UUID#<=>
+比較。RFC4122によるとなぜかUUIDは順序つきなんだそうだ。何に使うのか不明。RFCに準
+拠するためだけのメソッド。
+
+* UUID#to_i, UUID#to_int
+128bit unsigned intとみなして整数化。
+
+* UUID#to_s, UUID#to_uri, UUID#guid
+人間が読める文字列にする。to_uriはRFC4122が定めるURIとして変換。guidはよく
+Windowsとかで見るあれ。
+
+* UUID#raw_bytes
+これも文字列を返すんだけど、基本的には読めない。128bit長のUUID値そのもの。
+
+
+# Local Variables:
+# mode: text
+# indent-tabs-mode: t
+# tab-width: 8
+# fill-column: 79
+# default-justification: full
+# End:

data/doc/sample.css

@@ -89,3 +89,20 @@ div h5 {
     font-size: larger;
     border-bottom: solid 1px #000000;
 }
+
+p {
+    text-indent: 1em;
+}
+
+p.caption {
+    font-weight: bold;
+    text-indent: 0em;
+}
+
+p.noindent {
+    text-indent: 0em;
+}
+
+p.flushright {
+    text-align: right;
+}

data/doc/sample.yaml

@@ -28,19 +28,23 @@ aut: 吟遊詩人
 #
 # coverimage: カバー用画像。画像ディレクトリ内に置いてもディレクトリ名は不要(例: cover.jpg)
 #
-# 固有IDに使用するドメイン
-urnid: example.jp
+# 固有IDに使用するドメイン。指定しない場合には、時刻に基づくランダムUUIDが入る
+# urnid: urn:uid:http://example.com/some-book-title/1.0.2/
 # CSSファイル (yamlファイルおよびReVIEWファイルを置いたディレクトリにあること)
-stylesheet: sample.css
+stylesheet: stylesheet.css
+# LaTeX用のスタイルファイル(styディレクトリ以下に置くこと)
+# texstyle: samplemacro
 # 目次として抽出するレベル
 toclevel: 3
 # セクション番号を表示するレベル
 secnolevel: 2
 # EPUB標準の目次以外に目次を作成するか
 # mytoc: nil
+# 奥付を作成するか。デフォルトでは作成されない。trueを指定するとデフォルトの奥付、ファイル名を指定するとそれがcolophon.htmlとしてコピーされる
+# colophon: true
 # XHTML生成後に実行するプログラム。$1:HTMLの生成されたディレクトリ $2:ReVIEWファイルのあるディレクトリ $3:起動時指定のyamlファイル名
 # posthook: hook.sh
 # review-compileに渡すパラメータ
 params: --stylesheet=sample.css
-# デバッグフラグ。nilのときには一時ファイルをカレントディレクトリに作成し、削除もしない
+# デバッグフラグ。nilでないときには一時ファイルをカレントディレクトリに作成し、削除もしない
 # debug: nil

data/lib/lineinput.rb

@@ -18,7 +18,7 @@ class LineInput
   end
 
   def inspect
-    "\#<#{self.class} file=#{@f.inspect} line=#{lineno()}>"
+    "\#<#{self.class} file=#{@input.inspect} line=#{lineno()}>"
   end
 
   def eof?

data/lib/review/book.rb

@@ -27,9 +27,11 @@ module ReVIEW
 
   class Book
 
+    attr_accessor :param
+
     def Book.load_default
       %w( . .. ../.. ).each do |basedir|
-        if File.file?("#{basedir}/PARAMS") or File.file?("#{basedir}/CHAPS")
+        if File.file?("#{basedir}/CHAPS")
           return load(basedir)
         end
       end
@@ -38,14 +40,7 @@ module ReVIEW
 
     def Book.load(dir)
       update_rubyenv dir
-      if File.file?("#{dir}/PARAMS")
-      then new(dir, Parameters.load("#{dir}/PARAMS"))
-      else new(dir)
-      end
-    end
-
-    def setParameter(param)
-      @param = param
+      new(dir)
     end
 
     @basedir_seen = {}
@@ -73,9 +68,7 @@ module ReVIEW
                    :chapter_file,
                    :part_file,
                    :bib_file,
-                   :index_file,
                    :reject_file,
-                   :nocode_file,
                    :predef_file,
                    :postdef_file,
                    :ext,
@@ -109,7 +102,6 @@ module ReVIEW
 
     def chapter_index
       @chapter_index ||= ChapterIndex.new(chapters())
-      @chapter_index.setParameter(@param)
       @chapter_index
     end
 
@@ -278,10 +270,8 @@ module ReVIEW
         :chapter_file => const_get_safe(mod, :CHAPS_FILE),
         :part_file    => const_get_safe(mod, :PART_FILE),
         :bib_file     => const_get_safe(mod, :BIB_FILE),
-        :index_file   => const_get_safe(mod, :INDEX_FILE),
         :reject_file  => const_get_safe(mod, :REJECT_FILE) ||
                          const_get_safe(mod, :WORDS_FILE),
-        :nocode_file  => const_get_safe(mod, :NOCODE_FILE),
         :predef_file  => const_get_safe(mod, :PREDEF_FILE),
         :postdef_file => const_get_safe(mod, :POSTDEF_FILE),
         :ext          => const_get_safe(mod, :EXT),
@@ -313,16 +303,14 @@ module ReVIEW
     def initialize(params = {})
       @chapter_file = params[:chapter_file] || 'CHAPS'
       @part_file = params[:part_file]       || 'CHAPS'
-      @index_file   = params[:index_file]   || 'INDEX'
       @reject_file  = params[:reject_file]  || 'REJECT'
-      @nocode_file  = params[:nocode_file]  || 'NOCODE'
       @predef_file  = params[:predef_file]  || 'PREDEF'
       @postdef_file = params[:postdef_file] || 'POSTDEF'
       @page_metric  = params[:page_metric]  || PageMetric.a5
       @ext          = params[:ext]          || '.re'
       @image_dir    = params[:image_dir]    || 'images'
       @image_types  = unify_exts(params[:image_types]  ||
-                                 %w( eps tif tiff png bmp jpg jpeg gif svg ))
+                                 %w( eps ai tif tiff png bmp jpg jpeg gif svg ))
       @bib_file  = params[:bib_file]        || "bib#{@ext}"
     end
 
@@ -342,9 +330,7 @@ module ReVIEW
     path_param  :chapter_file
     path_param  :part_file
     path_param  :bib_file
-    path_param  :index_file
     path_param  :reject_file
-    path_param  :nocode_file
     path_param  :predef_file
     path_param  :postdef_file
     attr_reader :ext
@@ -438,10 +424,9 @@ module ReVIEW
       @table_index = nil
       @footnote_index = nil
       @image_index = nil
-    end
-
-    def setParameter(param)
-      @param = param
+      @numberless_image_index = nil
+      @indepimage_index = nil
+      @headline_index = nil
     end
 
     def env
@@ -482,11 +467,11 @@ module ReVIEW
           end
         }
       }
-      if @param["inencoding"] =~ /^EUC$/
+      if ReVIEW.book.param["inencoding"] =~ /^EUC$/
         @title = NKF.nkf("-E -w", @title)
-      elsif @param["inencoding"] =~ /^SJIS$/
+      elsif ReVIEW.book.param["inencoding"] =~ /^SJIS$/
         @title = NKF.nkf("-S -w", @title)
-      elsif @param["inencoding"] =~ /^JIS$/
+      elsif ReVIEW.book.param["inencoding"] =~ /^JIS$/
         @title = NKF.nkf("-J -w", @title)
       else
         @title = NKF.nkf("-w", @title)
@@ -507,11 +492,11 @@ module ReVIEW
     end
 
     def content
-      if @param["inencoding"] =~ /^EUC$/i
+      if ReVIEW.book.param["inencoding"] =~ /^EUC$/i
         @content = NKF.nkf("-E -w", File.read(path()))
-      elsif @param["inencoding"] =~ /^SJIS$/i
+      elsif ReVIEW.book.param["inencoding"] =~ /^SJIS$/i
         @content = NKF.nkf("-S -w", File.read(path()))
-      elsif @param["inencoding"] =~ /^JIS$/i
+      elsif ReVIEW.book.param["inencoding"] =~ /^JIS$/i
         @content = NKF.nkf("-J -w", File.read(path()))
       else
         @content = NKF.nkf("-w", File.read(path())) # auto detect
@@ -529,7 +514,6 @@ module ReVIEW
 
     def list_index
       @list_index ||= ListIndex.parse(lines())
-      @list_index.setParameter(@param)
       @list_index
     end
 
@@ -539,7 +523,6 @@ module ReVIEW
 
     def table_index
       @table_index ||= TableIndex.parse(lines())
-      @table_index.setParameter(@param)
       @table_index
     end
 
@@ -549,22 +532,36 @@ module ReVIEW
 
     def footnote_index
       @footnote_index ||= FootnoteIndex.parse(lines())
-      @footnote_index.setParameter(@param)
       @footnote_index
     end
 
     def image(id)
-      image_index()[id]
+      return image_index()[id] if image_index().has_key?(id)
+      return numberless_image_index()[id] if numberless_image_index().has_key?(id)
+      indepimage_index()[id]
+    end
+
+    def numberless_image_index
+      @numberless_image_index ||=
+        NumberlessImageIndex.parse(lines(), id(),
+                                   "#{book.basedir}#{@book.image_dir}",
+                                   @book.image_types)
     end
 
     def image_index
       @image_index ||= ImageIndex.parse(lines(), id(),
                                         "#{book.basedir}#{@book.image_dir}",
                                         @book.image_types)
-      @image_index.setParameter(@param)
       @image_index
     end
 
+    def indepimage_index
+      @indepimage_index ||=
+        IndepImageIndex.parse(lines(), id(),
+                                   "#{book.basedir}#{@book.image_dir}",
+                                   @book.image_types)
+    end
+
     def bibpaper(id)
       bibpaper_index()[id]
     end
@@ -572,9 +569,19 @@ module ReVIEW
     def bibpaper_index
       raise FileNotFound, "no such bib file: #{@book.bib_file}" unless @book.bib_exist?
       @bibpaper_index ||= BibpaperIndex.parse(@book.read_bib.lines.to_a)
-      @bibpaper_index.setParameter(@param)
       @bibpaper_index
     end
-  end
 
+    def headline(caption)
+      headline_index()[caption]
+    end
+
+    def headline_index
+      @headline_index ||= HeadlineIndex.parse(lines(), self)
+    end
+
+    def on_CHAPS?
+      @book.read_CHAPS().lines.map(&:strip).include?(id() + @book.ext())
+    end
+  end
 end