review 5.5.0 → 5.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1f097d4affd13c0fc3522a4b8a95f7cc293c6ae1f5096060d8cb3a27e55bfe0
-  data.tar.gz: 3690f0b732e216aca3a2a267f16b15f838d86facbb3615d07f70eae83223054e
+  metadata.gz: 11969067c8cb25999f37895ba330bd5c030c62402d1540510e241c6029c38d90
+  data.tar.gz: 4294e10f33abcb6063ea0098c3b7256374a5696d693fe2284dcb0fed4f2b2348
 SHA512:
-  metadata.gz: 99517b9b71d5d8adf7c89cfc9c2f09d9a53efdffccadef5f57881e0e205d1b6415f1d9e5bdd9ad0847787b5176a7b4da5a00150752de880a31145cc1224e8cd8
-  data.tar.gz: fbf5fcde5e37bc49ad32cc0f1ac96cfca2b88f35f2067c16ce2f3a35758426ea50c5eaf7ef91eaad174f7bfc07bec05f254106cbf969152d1a6fd7b7fe79a197
+  metadata.gz: dddd61f8870c1f2e0d1117d3318cb456bcf49db10a12c4c93dc8b7638b08e5b6894efdfbdbd635d432196f82d40f906b29435f4f6e5ddbb78d2dcbd3829715af
+  data.tar.gz: 695257c02903d581c061cd7813e8951923a4a63986e879aa6e6ee31d963d627bf0e9512f85ffc56ca6a596a8f8f114ed012c3cce9daa7dd41072aabc89a9cb3d

data/.github/workflows/rubocop.yml

@@ -0,0 +1,31 @@
+name: Lint by RuboCop
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.7', '3.0', '3.1', '3.2']
+        os: [ubuntu-latest]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: fix ImageMagick policy.xml on Linux
+      if: runner.os == 'Linux'
+      run: sudo sed -i 's/none/read|write/g' /etc/ImageMagick-6/policy.xml
+    - name: Build and test with Rake
+      run: |
+        gem install bundler --no-document
+        bundle install --retry 3
+        bundle exec rubocop -P

data/.github/workflows/ruby-tex.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.5', '3.0', '3.1']
+        ruby: ['2.7', '3.2']
         os: [ubuntu-20.04]
     steps:
     - uses: actions/checkout@v2

data/.github/workflows/ruby-win.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '3.0', '2.7', '2.6', '2.5', '2.4' ]
+        ruby: [ '3.2', '3.1', '3.0', '2.7' ]
 
     steps:
     - uses: actions/checkout@v2

data/.github/workflows/ruby.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.4', '2.5', '2.6', '2.7', '3.0', '3.1']
+        ruby: ['2.7', '3.0', '3.1', '3.2']
         os: [ubuntu-latest, macOS-latest]
     steps:
     - uses: actions/checkout@v2
@@ -28,4 +28,4 @@ jobs:
       run: |
         gem install bundler --no-document
         bundle install --retry 3
-        bundle exec rake
+        bundle exec rake test

data/.rubocop.yml

@@ -5,7 +5,7 @@ AllCops:
     - tmp/*
   DisplayCopNames: true
   NewCops: enable
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
 
 require:
   - rubocop-performance
@@ -38,6 +38,9 @@ Performance/StringInclude:
 Performance/CollectionLiteralInLoop:
   Enabled: false
 
+Performance/MapCompact:
+  Enabled: false
+
 #### Style
 
 Style/AsciiComments:
@@ -109,7 +112,7 @@ Style/LineEndConcatenation:
   Enabled: false
 
 Style/MethodCallWithArgsParentheses:
-  IgnoredMethods:
+  AllowedMethods:
     - 'require'
     - 'include'
     - 'file'
@@ -194,6 +197,9 @@ Style/OptionalBooleanParameter:
 Style/CombinableLoops:
   Enabled: false
 
+Style/FetchEnvVar:
+  Enabled: false
+
 ### Layout
 
 Layout/BlockAlignment:
@@ -296,3 +302,8 @@ Naming/VariableNumber:
 
 Gemspec/RequiredRubyVersion:
   Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+  Exclude:
+    - samples/syntax-book/Gemfile

data/NEWS.ja.md

@@ -1,3 +1,43 @@
+# Version 5.7.0
+## バグ修正
+* Windows において、`review-init -w` の実行時にバインドアドレスを省略したときにエラーが発生するのを修正しました ([#1824])
+* PDFMaker: `//blankline` でページをまたいだときに、ページの先頭に空行が入るのを抑制しました ([#1872])
+* EPUBMaker: MathJax で数式を表現する際に、`<`, `>`, `&` を変換し、HTML のエラーが出ないようにしました ([#1876], [#1877])
+
+## 非互換の変更
+* 動作検証済みバージョンを Ruby 2.7 以降としました ([#1871])
+* EPUMaker: EPUB の検証ルールに従い、EPUB の目次に表紙へのリンクを含めました ([#1874])
+
+## その他
+* Ruby 3.2 を動作検証テスト対象に含めました ([#1871])
+* RuboCop 1.45.1 の指摘を反映しました ([#1878])
+
+[#1824]: https://github.com/kmuto/review/issues/1824
+[#1871]: https://github.com/kmuto/review/pull/1871
+[#1872]: https://github.com/kmuto/review/issues/1872
+[#1874]: https://github.com/kmuto/review/issues/1874
+[#1876]: https://github.com/kmuto/review/pull/1876
+[#1877]: https://github.com/kmuto/review/pull/1877
+[#1878]: https://github.com/kmuto/review/pull/1878
+
+# Version 5.6.0
+## 新機能
+* IDGXMLBuilder: `//texequation` と `@<m>` で `imgmath` math_formatに対応しました ([#1829])
+* LATEXBuilder: `@<icon>`用のマクロとして`reviewicon`マクロを追加し、 `reviewincludegraphics`マクロの代わりに使うようにしました ([#1838])
+* ルビ文字列の前後のスペースを削除するようにしました ([#1839])
+
+## 非互換の変更
+* LATEXBuilder: 囲み記事の見出しとして `■メモ` の代わりに `MEMO`, `NOTICE`, `CAUTION` 等を使うようにしました。以前の見出しを使う場合は`locale.yml`に記載してください ([#1856])
+
+## その他
+* ドキュメント `format.md` と `format.ja.md` を更新しました ([#1860])
+
+[#1829]: https://github.com/kmuto/review/pull/1829
+[#1838]: https://github.com/kmuto/review/pull/1838
+[#1839]: https://github.com/kmuto/review/pull/1839
+[#1856]: https://github.com/kmuto/review/pull/1856
+[#1860]: https://github.com/kmuto/review/pull/1860
+
 # Version 5.5.0
 ## 新機能
 * 節や項を参照するインライン命令として、 `@<secref>` , `@<sec>` , `@<sectitle>` を追加しました。`@<secref>` は節や項の番号+タイトルを含むテキスト（ `@<hd>` と同じ）、 `@<sec>` は節や項の番号のみ、`@<sectitle>` はタイトルのみに展開されます ([#1809])

data/NEWS.md

@@ -1,3 +1,42 @@
+# Version 5.7.0
+## Bug Fixes
+* Fixed error when omitting a bind address of `review-init -w` on Windows ([#1824])
+* EPUBMaker: escape `<`, `>`, and `&` when converting to MathJax to avoid HTML errors ([#1876], [#1877])
+
+## Breaking Changes
+* Ruby 2.6 or earlier was excluded from the operation verification ([#1871])
+* EPUMaker: included a link to the cover in the table of contents according to EPUB validation rules ([#1874])
+
+## Others
+* Ruby 3.2 is now included in the testing target ([#1871])
+* refactor code with RuboCop 1.45.1 ([#1878])
+
+[#1824]: https://github.com/kmuto/review/issues/1824
+[#1871]: https://github.com/kmuto/review/pull/1871
+[#1872]: https://github.com/kmuto/review/issues/1872
+[#1874]: https://github.com/kmuto/review/issues/1874
+[#1876]: https://github.com/kmuto/review/pull/1876
+[#1877]: https://github.com/kmuto/review/pull/1877
+[#1878]: https://github.com/kmuto/review/pull/1878
+
+# Version 5.6.0
+## New Features
+* IDGXMLBuilder: support `imgmath` math_format in `//texequation` and `@<m>` ([#1829])
+* LATEXBuilder: use `reviewicon` macro instead of `reviewincludegraphics` in `@<icon>` ([#1838])
+* trim spaces before/after characters in ruby text ([#1839])
+
+## Breaking Changes
+* LATEXBuilder: use `MEMO`, `NOTICE`, `CAUTION` or other headers instead of `■メモ`. If you want to use older headers, add `■メモ` in `locale.yml`. ([#1856])
+
+## Others
+* update documents `format.md` and `format.ja.md` ([#1860])
+
+[#1829]: https://github.com/kmuto/review/pull/1829
+[#1838]: https://github.com/kmuto/review/pull/1838
+[#1839]: https://github.com/kmuto/review/pull/1839
+[#1856]: https://github.com/kmuto/review/pull/1856
+[#1860]: https://github.com/kmuto/review/pull/1860
+
 # Version 5.5.0
 ## New Features
 * introduced `@<secref>`, `@<sec>`, and `@<sectitle>` as inline op to refer sections ([#1809])

data/README.md

@@ -117,4 +117,4 @@ Exception:
 
 ## Copyright
 
-Copyright (c) 2006-2022 Minero Aoki, Kenshi Muto, Masayoshi Takahashi, Masanori Kado.
+Copyright (c) 2006-2023 Minero Aoki, Kenshi Muto, Masayoshi Takahashi, Masanori Kado.

data/doc/format.ja.md

@@ -96,7 +96,7 @@ Re:VIEW フォーマットの文法について解説します。Re:VIEW フォ
 
 ## 番号付き箇条書き
 
-番号付きの箇条書き（HTML で言う ol）は「` 1. 〜`」「` 2. 〜`」「` 3. 〜`」のように示します。ネストはサポートしていません。
+番号付きの箇条書き（HTML で言う ol）は「` 1. 〜`」「` 2. 〜`」「` 3. 〜`」のように示します。`1-1` のようなネスト出力は標準では提供していません（ `//beginchild` 〜 `//endchild` を使った入れ子の表現は可能です）。
 
 例:
 
@@ -108,6 +108,23 @@ Re:VIEW フォーマットの文法について解説します。Re:VIEW フォ
 
 番号付き箇条書きも、ただの箇条書きと同様、行頭に1つ以上の空白が必要です。
 
+数字が実際にそのとおり出るかは、出力を行うソフトウェアに依存します。
+
+- HTML (EPUB), TeX: 記入の数字にかかわらず1から始まる番号になります。
+- IDGXML, テキスト: 記入したとおりの番号が出力されます。よって、すべて「1.」にするといった形にしてしまうとおかしな結果になります。
+
+HTML (EPUB) や TeX ビルダにおいて最初の番号を 1 ではないものにしたいときには、`//olnum[番号]` を指定します。なお、番号箇条書きの途中の番号を変えることはできません。
+
+例:
+
+```
+//olnum[10]
+
+ 1. この箇条書きの番号は出力ソフトウェア上では10になる
+ 2. これは11になる
+ 6. 記入上で飛ばしても連続数で12となる
+```
+
 ## 用語リスト
 
 用語リスト（HTML で言う dl）は空白→「:」→空白、で始まる行を使って示します。
@@ -186,7 +203,7 @@ Re:VIEW フォーマットの文法について解説します。Re:VIEW フォ
 
 ## ソースコードなどのリスト
 
-ソースコードなどのリストには`//list`を使います。連番を付けたくない場合は先頭に `em`（embedded の略）、行番号を付ける場合は末尾に `num` を付加します。まとめると、以下の4種類になります。
+ソースコードなどのリストには `//list` を使います。連番を付けたくない場合は先頭に `em`（embedded の略）、行番号を付ける場合は末尾に `num` を付加します。まとめると、以下の4種類になります。
 
 * `//list[識別子][キャプション][言語指定]{ 〜 //}`
   * 通常のリスト。言語指定は省略できます。
@@ -471,7 +488,7 @@ complexmatrixという識別子に基づく画像ファイルが貼り込まれ
 //}
 ```
 
-## 引用
+## 引用・中央揃え・右揃え
 
 引用は「`//quote{ 〜 //}`」を使って記述します。
 
@@ -485,6 +502,24 @@ complexmatrixという識別子に基づく画像ファイルが貼り込まれ
 
 複数の段落を入れる場合は、空行で区切ります。
 
+中央揃えの段落を表現するには、「`//centering{ 〜 //}`」を使います。同様に右寄せにするには「`//flushright{ 〜 //}`」を使います。複数の段落を入れる場合は、空行で区切ります。
+
+例:
+
+```
+//centering{
+これは
+
+中央合わせ
+//}
+
+//flushright{
+これは
+
+右寄せ合わせ
+//}
+```
+
 ## 囲み記事
 
 技術書でよくある、コラムにするほどではないけれども本文から独立したちょっとした記事を入れるために、以下の命令があります。
@@ -634,7 +669,7 @@ LaTeX の式を挿入するには、`//texequation{ 〜 //}` を使います。
 
 参照するにはインライン命令 `@<eq>` を使います（たとえば `@<eq>{emc}`）。
 
-インライン命令では `@<m>{〜}` を使います。インライン命令の式中に「}」を含む場合、`\}` とエスケープする必要があることに注意してください（`{` はエスケープ不要）。「インライン命令のフェンス記法」も参照してください。
+インライン命令では `@<m>{〜}` を使います。インライン命令の式中に「}」を含む場合、`\}` とエスケープする必要があることに注意してください（`{` はエスケープ不要）。長い式を書くときにはフェンス記法（`@<m>$〜$` または `@<m>|〜|`）を使うと、エスケープが不要になり、記述が楽になります。「インライン命令のフェンス記法」を参照してください。
 
 LaTeX の数式が正常に整形されるかどうかは処理系に依存します。LaTeX を利用する PDFMaker では問題なく利用できます。
 
@@ -889,32 +924,7 @@ Lesser General Public License, ★"i"nternationalizatio"n"☆
 
 ## 生データ行
 
-Re:VIEW のタグ範囲を超えて何か特別な行を挿入したい場合、`//raw` ブロック命令や`//embed`ブロック命令、または `@<raw>` インライン命令や `@<embed>` インライン命令を使います。
-
-### `//raw`行
-
-例:
-
-```
-//raw[|html|<div class="special">\nここは特別な行です。\n</div>]
-```
-
-ブロック命令は1つだけオプションをとり、「|ビルダ名|そのまま出力させる内容」という書式です。`\n`は改行文字に変換されます。
-
-ビルダ名には「`html`」「`latex`」「`idgxml`」「`markdown`」「`top`」のいずれかが入ります。ビルダ名は「,」で区切って複数指定することも可能です。該当のビルダを使用しているときのみ、内容が出力されます。
-
-例:
-
-```
-（HTMLビルダの場合:）
-<div class="special">
-ここは特別な行です。
-</div>
-
-（ほかのビルダの場合は単に無視されて何も出力されない）
-```
-
-インライン命令は、`@<raw>{|ビルダ名|〜}` という書式で、記述はブロック命令に同じです。
+Re:VIEW のタグ範囲を超えて何か特別な行を挿入したい場合、`//embed`ブロック命令や `@<embed>` インライン命令を使います。ほかに従来の `//raw` ブロック命令および `@<raw>` インライン命令もありますが、IDGXML ビルダ以外での使用は推奨しません。
 
 ### `//embed`ブロック
 
@@ -963,13 +973,38 @@ LaTeXビルダを使用している場合:
 
 ```
 
+### `//raw`行（IDGXML ビルダ以外では非推奨）
+
+例:
+
+```
+//raw[|html|<div class="special">\nここは特別な行です。\n</div>]
+```
+
+ブロック命令は1つだけオプションをとり、「|ビルダ名|そのまま出力させる内容」という書式です。`\n`は改行文字に変換されます。
+
+ビルダ名には「`html`」「`latex`」「`idgxml`」「`markdown`」「`top`」のいずれかが入ります。ビルダ名は「,」で区切って複数指定することも可能です。該当のビルダを使用しているときのみ、内容が出力されます。
+
+例:
+
+```
+（HTMLビルダの場合:）
+<div class="special">
+ここは特別な行です。
+</div>
+
+（ほかのビルダの場合は単に無視されて何も出力されない）
+```
+
+インライン命令は、`@<raw>{|ビルダ名|〜}` という書式で、記述はブロック命令に同じです。
+
 `//raw`、`//embed`、`@<raw>` および `@<embed>` は、HTML、XML や TeX の文書構造を容易に壊す可能性があります。使用には十分に注意してください。
 
 ### 入れ子の箇条書き
 
 Re:VIEW の箇条書きは `*` 型の箇条書きを除き、基本的に入れ子を表現できません。いずれの箇条書きも、別の箇条書き、あるいは図表・リストを箇条書きの途中に配置することを許容していません。
 
-この対策として、Re:VIEW 4.2 では試験的に `//beginchild`、`//endchild` というブロック命令を追加しています。箇条書きの途中に何かを含めたいときには、それを `//beginchild` 〜 `//endchild` で囲んで配置します。多重に入れ子にすることも可能です。
+この対策として、Re:VIEW 4.2 以降では `//beginchild`、`//endchild` というブロック命令があります。箇条書きの途中に何かを含めたいときには、それを `//beginchild` 〜 `//endchild` で囲んで配置します。多重に入れ子にすることも可能です。
 
 ```
  * UL1
@@ -1054,6 +1089,8 @@ UL1-OL1-PARAGRAPH
 * `@<tcy>{〜}` : 縦書きの文書において文字を縦中横にします。
 * `@<ins>{〜}` : 挿入箇所を明示します（デフォルトでは下線が引かれます）。
 * `@<del>{〜}` : 削除箇所を明示します（デフォルトでは打ち消し線が引かれます）。
+* `@<sup>{〜}` : 上付き文字にします。
+* `@<sub>{〜}` : 下付き文字にします。
 
 ### 参照
 * `@<chap>{章ファイル名}` : 「第17章」のような、章番号を含むテキストに置換されます。
@@ -1067,7 +1104,7 @@ UL1-OL1-PARAGRAPH
 * `@<column>{ラベルまたは見出し}` : コラムを参照します。
 
 ### その他
-* `@<ruby>{親文字, ルビ}` : ルビを振ります。たとえば `@<ruby>{愕然, がくぜん}` のように表記します。
+* `@<ruby>{親文字,ルビ}` : ルビを振ります。たとえば `@<ruby>{愕然,がくぜん}` のように表記します。
 * `@<br>{}` : 段落途中で改行します。濫用は避けたいところですが、表のセル内や箇条書き内などで必要になることもあります。
 * `@<uchar>{番号}` : Unicode文字を出力します。引数は16進数で指定します。
 * `@<href>{URL}`, `@<href>{URL, 文字表現}` : ハイパーリンクを作成します（後述）。
@@ -1075,8 +1112,8 @@ UL1-OL1-PARAGRAPH
 * `@<m>{数式}` : インラインの数式を出力します。
 * `@<w>{キー}` : キー文字列に対応する、単語ファイル内の値文字列を展開します。
 * `@<wb>{キー}` : キー文字列に対応する、単語ファイル内の値文字列を展開し、太字にします。
-* `@<raw>{|ビルダ|〜}` : 生の文字列を出力します。`\}`は`}`に、`\\`は`\`に、`\n`は改行に置き換えられます。
 * `@<embed>{|ビルダ|〜}` : 生の文字列を埋め込みます。`\}`は`}`に、`\\`は`\`に置き換えられます（`\n`はそのままです）。
+* `@<raw>{|ビルダ|〜}` : 生の文字列を出力します。`\}`は`}`に、`\\`は`\`に、`\n`は改行に置き換えられます（非推奨）。
 * `@<idx>{文字列}` : 文字列を出力するとともに、索引として登録します。索引の使い方については、makeindex.ja.md を参照してください。
 * `@<hidx>{文字列}` : 索引として登録します (idx と異なり、紙面内に出力はしません)。`親索引文字列<<>>子索引文字列` のように親子関係にある索引も定義できます。
 * `@<balloon>{〜}` : コードブロック (emlist など) 内などでのいわゆる吹き出しを作成します。たとえば「`@<balloon>{ABC}`」とすると、「`←ABC`」となります。デフォルトの挙動および表現は簡素なので、より装飾されたものにするにはスタイルシートを改変するか、`review-ext.rb` を使って挙動を書き換える必要があります。

data/doc/format.md

@@ -4,7 +4,7 @@ The document is a brief guide for Re:VIEW markup syntax.
 
 Re:VIEW is based on EWB of ASCII (now KADOKAWA), influenced RD and other Wiki system's syntax.
 
-This document explains about the format of Re:VIEW 5.3.
+This document explains about the format of Re:VIEW 5.5.
 
 ## Paragraph
 
@@ -112,7 +112,7 @@ You should add emply lines between Paragraphs and Itemize (same as Ordered and N
 ## Ordered Itemize
 
 Ordered itemize (ol in HTML)  uses ` 1. ...`, ` 2. ...`, ` 3. ...`.
-They aren't nested.
+Nesting output like `1-1` is not supported by default (nesting can be expressed using `//beginchild` - `//endchild`).
 
 Usage:
 
@@ -122,15 +122,24 @@ Usage:
  3. 3rd condition
 ```
 
-The value of Number is ignored.
+You must write one more space character at line head like itemize.
+
+Whether the numbers appear as described depends on the software that produces the output.
+
+* HTML (EPUB), TeX: The number will start from 1 regardless of the number entered.
+* IDGXML, text: The numbers will be output as described. Therefore, writing all numbers as "1." will produce strange results.
+
+In HTML (EPUB) and TeX builders, use `//olnum[number]` to change the first number. Note that the intermediate numbers cannot be changed.
+
+Usage:
 
 ```
- 1. 1st condition
- 1. 2nd condition
- 1. 3rd condition
-```
+//olnum[10]
 
-You must write one more space character at line head like itemize.
+ 1. This number will be 10
+ 2. This number will be 11
+ 6. 12 in continuity, not 6 or 15.
+```
 
 ## Definition List
 
@@ -512,6 +521,26 @@ Seeing is believing.
 
 You can use inline markup in quotations.
 
+Center-aligned paragraphs are represented by `//centering{ ~ //}` and right-aligned paragraphs by `//flushright{ ~ //}`.
+
+To include multiple paragraphs, separate them with a blank line.
+
+Usage:
+
+```
+//centering{
+This is
+
+center aligned.
+//}
+
+//flushright{
+This is
+
+right aligned.
+//}
+```
+
 ## Short column
 
 Some block commands are used for short column.
@@ -670,7 +699,7 @@ If you'd like to assign a number like 'Equation 1.1`, specify the identifier and
 
 To reference this, use the inline command `@<eq>`.
 
-There is `@<m>{ ... }` for inline (see "Fence notation for inline commands" section also).
+There is `@<m>{ ... }` for inline. When writing long expressions, it is convenient to use fence notation (`@<m>$~$` or `@<m>|~|`) to avoid escaping. (see "Fence notation for inline commands" section also).
 
 Whether LaTeX formula is correctly displayed or not depends on the processing system. PDFMaker uses LaTeX internally, so there is no problem.
 
@@ -943,20 +972,27 @@ Usage:
 
 ## Raw Data Block
 
-When you want to write non-Re:VIEW line, use `//raw` or `//embed`.
+When you want to write non-Re:VIEW line, use `//embed` or `@<embed>`.
 
-### `//raw` block
+### `//embed` block
 
 Usage:
 
 ```
-//raw[|html|<div class="special">\nthis is a special line.\n</div>]
+//embed{
+<div class="special">
+this is a special line.
+</div>
+//}
+
+//embed[html,markdown]{
+<div class="special">
+this is a special line.
+</div>
+//}
 ```
 
-In above line, `html` is a builder name that handle raw data.
-You can use `html`, `latex`, `idgxml` and `top` as builder name.
-You can specify multiple builder names with separator `,`.
-`\n` is translated into newline(U+000A).
+In above line, `html` and `markdown` is a builder name that handle raw data.
 
 Output:
 
@@ -970,27 +1006,22 @@ this is a special line.
 
 (In other formats, it is just ignored.)
 
-Note: `//raw` and `@<raw>` may break structured document easily.
+For inline, use `@<embed>{|builder|raw string}`.
 
-### `//embed` block
+### `//raw` block
+
+`//raw` and `@<raw>` is an old notation and should no longer be used (use it only if you want to avoid line breaks in IDGXML builder).
 
 Usage:
 
 ```
-//embed{
-<div class="special">
-this is a special line.
-</div>
-//}
-
-//embed[html,markdown]{
-<div class="special">
-this is a special line.
-</div>
-//}
+//raw[|html|<div class="special">\nthis is a special line.\n</div>]
 ```
 
-In above line, `html` and `markdown` is a builder name that handle raw data.
+In above line, `html` is a builder name that handle raw data.
+You can use `html`, `latex`, `idgxml` and `top` as builder name.
+You can specify multiple builder names with separator `,`.
+`\n` is translated into newline(U+000A).
 
 Output:
 
@@ -1004,11 +1035,13 @@ this is a special line.
 
 (In other formats, it is just ignored.)
 
+Note: `//embed`, `@<embed>`, `//raw` and `@<raw>` may break structured document easily.
+
 ### Nested itemize block
 
 Re:VIEW itemize blocks basically cannot express nested items. Also, none of itemize blocks allow to contain another itemize block or paragraph/image/table/list.
 
-As a workaround, Re:VIEW 4.2 provides an experimental `//beginchild` and `//endchild`. If you want to include something in an itemize block, enclose it with `//beginchild` and `//endchild`. It is also possible to create a multiple nest.
+As a workaround, Re:VIEW provides `//beginchild` and `//endchild` since Re:VIEW 4.2. If you want to include something in an itemize block, enclose it with `//beginchild` and `//endchild`. It is also possible to create a multiple nest.
 
 ```
  * UL1
@@ -1091,9 +1124,11 @@ Output:
 @<tti>{FooClass}:: teletype (monospaced font) and italic
 @<ttb>{BarClass}:: teletype (monospaced font) and bold
 @<code>{a.foo(bar)}:: teletype (monospaced font) for fragments of code
-@<tcy>{}:: short horizontal text in vertical text
+@<tcy>{text}:: short horizontal text in vertical text
 @<ins>{sentence}:: inserted part (underline)
 @<del>{sentence}:: deleted part (strike through)
+@<sup>{text}:: superscript
+@<sub>{text}:: subscript
 ```
 
 ### References
@@ -1113,7 +1148,7 @@ Output:
 ### Other inline commands
 
 ```
-@<ruby>{Matsumoto, Matz}:: ruby markups
+@<ruby>{Matsumoto,Matz}:: ruby markups
 @<br>{}::  linebreak in paragraph
 @<uchar>{2460}:: Unicode code point
 @<href>{http://www.google.com/, google}:: hyper link(URL)
@@ -1121,8 +1156,8 @@ Output:
 @<m>{a + \alpha}:: TeX inline equation
 @<w>{key}:: expand the value corresponding to the key.
 @<wb>{key}:: expand the value corresponding to the key with bold style.
-@<raw>{|html|<span>ABC</span>}:: inline raw data inline. `\}` is `}`, `\\` is `\`, and `\n` is newline.
 @<embed>{|html|<span>ABC</span>}:: inline raw data inline. `\}` is `}` and `\\` is `\`.
+@<raw>{|html|<span>ABC</span>}:: inline raw data inline. `\}` is `}`, `\\` is `\`, and `\n` is newline. (deprecated)
 @<idx>{string}:: output a string and register it as an index. See makeindex.md.
 @<hidx>{string}:: register a string as an index. A leveled index is expressed like `parent<<>>child`
 @<balloon>{abc}:: inline balloon in code block. For example, `@<balloon>{ABC}` produces `←ABC`. This may seem too simple. To decorate it, modify the style sheet file or override a function by `review-ext.rb`

data/doc/quickstart.ja.md

@@ -67,7 +67,13 @@ review-init コマンドを使って、雛型となるプロジェクトフォ
 $ review-init プロジェクト名
 ```
 
-TeX を利用した PDF 作成を目的としているならば、雛型の作成時に、Web ブラウザによるウィザードモードで基本版面設計を行うことができます。これには `-w` オプションを付けます。
+TeX を利用した PDF 作成を目的としているならば、雛型の作成時に、Web ブラウザによるウィザードモードで基本版面設計を行うことができます。外部 gem の webrick が必要なので、インストールしておいてください。
+
+```
+$ gem install webrick
+```
+
+ウィザードモードで起動するため、review-init コマンドに `-w` オプションを付けます。
 
 ```
 $ review-init -w プロジェクト名

data/doc/quickstart.md

@@ -72,7 +72,13 @@ $ ls hello
 Rakefile     catalog.yml  config.yml   hello.re     images/      layouts/     sty/         style.css
 ```
 
-If your purpose is to create a PDF using TeX, it is a good idea to use the wizard mode for basic layouting in a web browser. Add `-w` option to review-init.
+If your purpose is to create a PDF using TeX, it is a good idea to use the wizard mode for basic layouting in a web browser. Because the wizard mode requires webrick library, please install webrick gem before running.
+
+```
+$ gem install webrick
+```
+
+Run review-init with `-w` option.
 
 (notice: currently wizard UI supports only Japanese language)
 

data/lib/review/book/base.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2009-2022 Minero Aoki, Kenshi Muto, Masayoshi Takahashi
+# Copyright (c) 2009-2023 Minero Aoki, Kenshi Muto, Masayoshi Takahashi
 #               2002-2008 Minero Aoki
 #
 # This program is free software.