review 4.1.0 → 5.2.0

data/doc/format.md

@@ -4,8 +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 3.0.
-
+This document explains about the format of Re:VIEW 5.1.
 
 ## Paragraph
 
@@ -284,7 +283,6 @@ puts "hello world!"
 //}
 ```
 
-
 ### Quoting Source Code
 
 `//source` is for quoting source code. filename is mandatory.
@@ -339,7 +337,6 @@ You can use `//image{ ... //}` for figures.
 You can write comments or Ascii art in the block as an alternative description.
 When publishing, it's simply ignored.
 
-
 Usage:
 
 ```
@@ -378,7 +375,7 @@ The order of finding image is as follows.  The first matched one is used.
 ```
 
 * ``<imgdir>`` is `images` as default.
-* ``<builder>`` is a builder (target) name to use.  When you use review-comile commmand with ``--target=html``, `<imagedir>/<builder>` is `images/html`.
+* ``<builder>`` is a builder (target) name to use.  When you use review-comile commmand with ``--target=html``, `<imagedir>/<builder>` is `images/html`. The builder name for epubmaker and webmaker is `html`, for pdfmaker it is `latex`, and for textmaker it is `top`.
 * ``<chapid>`` is basename of *.re file.  If the filename is `ch01.re`, chapid is `ch01`.
 * ``<id>`` is the ID of the first argument of `//image`.  You should use only printable ASCII characters as ID.
 * ``<ext>`` is file extensions of Re:VIEW.  They are different by the builder you use.
@@ -387,7 +384,7 @@ For each builder, image files are searched in order of the following extensions,
 
 * HTMLBuilder (EPUBMaker, WEBMaker), MARKDOWNBuilder: .png, .jpg, .jpeg, .gif, .svg
 * LATEXBuilder (PDFMaker): .ai, .eps, .pdf, .tif, .tiff, .png, .bmp, .jpg, .jpeg, .gif
-* Other builders: .ai, .psd, .eps, .pdf, .tif, .tiff, .png, .bmp, .jpg, .jpeg, .gif, .svg
+* Other builders/makers: .ai, .psd, .eps, .pdf, .tif, .tiff, .png, .bmp, .jpg, .jpeg, .gif, .svg
 
 ### Inline Images
 
@@ -532,6 +529,19 @@ Some block commands are used for short column.
 
 The content is like paragraph; separated by empty lines.
 
+From Re:VIEW 5.0, it is also possible to include itemize, figures and tables in short columns.
+
+```
+//note{
+
+With ordered itemize.
+
+ 1. item1
+ 2. item2
+
+//}
+```
+
 ## Footnotes
 
 You can use `//footnote` to write footnotes.
@@ -624,7 +634,7 @@ Usage:
 If you'd like to assign a number like 'Equation 1.1`, specify the identifier and caption.
 
 ```
-//texequationl[emc][The Equivalence of Mass and Energy]{
+//texequation[emc][The Equivalence of Mass and Energy]{
 \sum_{i=1}^nf_n(x)
 //}
 ```
@@ -635,7 +645,7 @@ There is `@<m>{ ... }` for inline (see "Fence notation for inline commands" sect
 
 Whether LaTeX formula is correctly displayed or not depends on the processing system. PDFMaker uses LaTeX internally, so there is no problem.
 
-EPUBMaker and WEBMaker use either MathML transformation or imaging.
+In EPUBMaker and WEBMaker, you can choose between MathML conversion, MathJax conversion, and imaging.
 
 ### MathML case
 Install MathML library (`gem install math_ml`).
@@ -643,11 +653,20 @@ Install MathML library (`gem install math_ml`).
 Specify in config.yml as follows:
 
 ```
-mathml: true
+math_format: mathml
 ```
 
 Whether it is displayed properly in MathML depends on your viewer or browser.
 
+### MathJax case
+Specify in config.yml as follows:
+
+```
+math_format: mathjax
+```
+
+MathJax JavaScript module is loaded from the Internet. Because the EPUB specification prohibits loading files from external, enabling this feature will cause the EPUB file to fail validation. Also MathJax will not work in almost all EPUB readers, but may be available with CSS formatting processor.
+
 ### imaging case
 
 This way calls LaTeX internally and images it with an external tool. Image files will be placed in `images/_review_math` folder.
@@ -662,7 +681,7 @@ In addition, external tools for image conversion are also needed. Currently, it
 By setting in config.yml,
 
 ```
-imgmath: true
+math_format: imgmath
 ```
 
 it is set as follows:
@@ -697,7 +716,7 @@ imgmath_options:
 For example, to make SVG:
 
 ```
-imgmath: true
+math_format: imgmath
 imgmath_options:
   format: svg
   pdfcrop_pixelize_cmd: "pdftocairo -svg -r 90 -f %p -l %p -singlefile %i %o"
@@ -708,7 +727,7 @@ By default, the command specified in `pdfcrop_pixelize_cmd` takes the filename o
 If you want to use the `sips` command or the` magick` command, they can only process a single page, so you need to set `extract_singlepage: true` to extract the specified page from the input PDF. `pdfjam` command (in TeXLive) is used to extract pages.
 
 ```
-imgmath: true
+math_format: imgmath
 imgmath_options:
   extract_singlepage: true
   # use pdftk instead of default pdfjam (for Windows)
@@ -722,7 +741,7 @@ imgmath_options:
 To create PDF math images:
 
 ```
-imgmath: true
+math_format: imgmath
 imgmath_options:
   format: pdf
   extract_singlepage: true
@@ -733,7 +752,7 @@ imgmath_options:
 To set the same setting as Re:VIEW 2:
 
 ```
-imgmath: true
+math_format: imgmath
 imgmath_options:
   converter: dvipng
   fontsize: 12
@@ -956,6 +975,75 @@ this is a special line.
 
 (In other formats, it is just ignored.)
 
+### 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.
+
+```
+ * UL1
+
+//beginchild
+#@# child of UL1 start
+
+ 1. UL1-OL1
+
+//beginchild
+#@# child of UL1-OL1 start
+
+UL1-OL1-PARAGRAPH
+
+ * UL1-OL1-UL1
+ * UL1-OL1-UL2
+
+//endchild
+#@# child of UL1-OL1 end
+
+ 2. UL1-OL2
+
+ : UL1-DL1
+        UL1-DD1
+ : UL1-DL2
+        UL1-DD2
+
+//endchild
+#@# child of UL1 end
+
+ * UL2
+```
+
+Output:
+
+(In HTML:)
+
+```
+<ul>
+<li>UL1
+<ol>
+<li>UL1-OL1
+<p>UL1-OL1-PARAGRAPH</p>
+<ul>
+<li>UL1-OL1-UL1</li>
+<li>UL1-OL1-UL2</li>
+</ul>
+</li>
+
+<li>UL1-OL2</li>
+</ol>
+<dl>
+<dt>UL1-DL1</dt>
+<dd>UL1-DD1</dd>
+<dt>UL1-DL2</dt>
+<dd>UL1-DD2</dd>
+</dl>
+</li>
+
+<li>UL2</li>
+</ul>
+```
+
+(This is an experimental implementation. Names and behaviors may change in future versions.)
 
 ## Inline Commands
 
@@ -975,6 +1063,8 @@ this is a special line.
 @<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
+@<ins>{sentence}:: inserted part (underline)
+@<del>{sentence}:: deleted part (strike through)
 ```
 
 ### References
@@ -1106,13 +1196,11 @@ C
 A,B,C
 ```
 
-
 ## HTML/LaTeX Layout
 
 `layouts/layout.html.erb` and `layouts/layout.tex.erb` are used as layout file.
 You can use ERb tags in the layout files.
 
-
 Sample layout file(layout.html.erb):
 
 ```html

data/doc/makeindex.ja.md

@@ -35,7 +35,7 @@ re ファイル内に、`@<idx>` または `@<hidx>` インラインタグを使
 
 [索引]
 ひ
-表示もする索引です....1
+表示もする索引....1
 ```
 
 ```
@@ -50,7 +50,7 @@ re ファイル内に、`@<idx>` または `@<hidx>` インラインタグを使
 
 
 ひ
- 表示もする索引です....1
+ 表示しない索引....1
 ```
 
 ## 読み辞書

data/doc/pdfmaker.ja.md

@@ -109,6 +109,48 @@ Re:VIEW 3.0 から review-jlreq.cls という別のクラスファイルも用
 
 その他の詳細な設定については、sty フォルダにある README.md を参照してください。
 
+### カスタムパラメータの引き渡し
+
+技術的な都合で、config.yml の YAML 設定から TeX のマクロへの変換はすべての設定について行われるわけではなく、ごく限られた値のみに制限しています。これは Re:VIEW 内部の `config.erb` ( https://github.com/kmuto/review/blob/master/templates/latex/config.erb ) の ERB スクリプトによって処理されており、この挙動を変更することは許容していません。
+
+任意の YAML 設定を TeX に引き渡すには、`config.erb` と同様に YAML から TeX への変換を行う固有の ERB スクリプトを作成して配置します。このためには、プロジェクトフォルダに `layouts` フォルダを作成し、そこに固有の ERB スクリプトを `config-local.tex.erb` という名前で置きます。
+
+`config-local.tex.erb` は `config.erb` の評価・埋め込みの後、評価・埋め込みされます。
+
+config.yml を次のようにして、これを TeX に渡したいとします。
+
+```
+mycustom:
+  mystring: HELLO_#1
+  mybool: true
+```
+
+`layouts/config-local.tex.erb` はたとえば次のようになります。
+
+```
+\def\mystring{<%= escape(@config['mycustom']['mystring']) %>}
+<%- if @config['mycustom']['mybool'] -%>
+\def\mybool{true}
+<%- end -%>
+```
+
+次のように展開されます。
+```
+ …
+\makeatother
+%% BEGIN: config-local.tex.erb
+\def\mystring{HELLO\textunderscore{}\#1}
+\def\mybool{true}
+%% END: config-local.tex.erb
+
+\usepackage{reviewmacro}
+ …
+```
+
+こうして定義されたマクロを sty ファイルなどで参照します。
+
+なお、ERB での YAML 解析、および TeX マクロの記述において誤りがあると、極めてわかりにくいエラーになることがあります。`--debug` オプション付きで実行して展開された `__REVIEW_BOOK__.tex` を確認して原因を調査するのがよいでしょう。
+
 ## Re:VIEW 2.0 以前の情報
 
 ### upLaTeX について

data/doc/pdfmaker.md

@@ -84,6 +84,47 @@ Since Re:VIEW 3.0, review-jlreq.cls is also provided. This class file extends jl
 
 `review-init --latex-template=review-jlreq` command copies the review-jlreq.cls set to `sty` folder.
 
+### Handing over custom parameters
+
+For technical reasons, only a small part of the YAML parameters in config.yml is converted to TeX macros. Re:VIEW's internal `config.erb` ( https://github.com/ kmuto/review/blob/master/templates/latex/ config.erb ) ERB script manages this. You cannot change this script.
+
+If you want to give YAML parameters to TeX, you can use your own ERB script that do the YAML to TeX conversion. This is done by creating `layouts/config-local.tex.erb` in the project folder.
+
+After evaluation and embedding of `config.erb`, `config-local.tex. erb` will be evaluated and embedded as well. For example,
+
+`config.yml`:
+
+```
+mycustom:
+  mystring: HELLO_#1
+  mybool: true
+```
+
+`layouts/config-local.tex.erb`:
+
+```
+\def\mystring{<%= escape(@config['mycustom']['mystring']) %>}
+<%- if @config['mycustom']['mybool'] -%>
+\def\mybool{true}
+<%- end -%>
+```
+
+will be parsed:
+
+```
+ …
+\makeatother
+%% BEGIN: config-local.tex.erb
+\def\mystring{HELLO\textunderscore{}\#1}
+\def\mybool{true}
+%% END: config-local.tex.erb
+
+\usepackage{reviewmacro}
+ …
+```
+
+Refer to these macros in your sty file.
+
 ## Important Changes about LaTeX in Re:VIEW 2.0
 
 * Default LaTeX compiler is upLaTeX, not pLaTeX.

data/doc/quickstart.ja.md

@@ -8,7 +8,7 @@ Re:VIEW は GNU Lesser General Public License Version 2.1 に基づいて配布
 
 このドキュメントでは、Re:VIEW のセットアップから変換の例までを簡単に説明します。
 
-このドキュメントは、Re:VIEW 4.0 に基づいています。
+このドキュメントは、Re:VIEW 5.1 に基づいています。
 
 ## セットアップ
 
@@ -160,6 +160,16 @@ config.yml のサンプルについては以下を参照してください。
 
 * [config.yml.sample](https://github.com/kmuto/review/blob/master/doc/config.yml.sample)
 
+#### Vivliostyle CLI を使った PDF 化
+
+TeX (`review-pdfmaker`、`rake pdf`) を利用する代わりに、[Vivliostyle CLI](https://github.com/vivliostyle/vivliostyle-cli) を使って PDF を作成することもできます。Re:VIEW が EPUB を作成したあと、VivliostyleCLI がそれを PDF に変換します。
+
+```bash
+$ rake vivliostyle:build    ← Vivliostyle を使って PDF を作成
+$ rake vivliostyle:preview  ← Chrome/Chromium ブラウザでプレビュー
+$ rake vivliostyle          ← vivliostyle:buildのショートカット
+```
+
 ### 章を増やす、カスタマイズする
 作成した PDF あるいは EPUB を見ると、先に作成した RE:VIEW フォーマットテキストファイルが「第1章」となっていることがわかります。
 
@@ -217,20 +227,23 @@ $ review-preproc --replace ファイル ←ファイルを更新したもので
 $ review-vol
 ```
 
-より細かな見出し一覧などを出したいときには、review-index コマンドを使うのもよいでしょう。
+より細かな見出し一覧などを出したいときには、review-index コマンドを使うとよいでしょう。
 
 ```bash
-$ review-index --level 掘り下げる見出しレベル数 -a
+$ review-index -l 掘り下げる見出しレベル数
+$ review-index -l 掘り下げる見出しレベル数 -d ←分量の詳細を表示
 ```
 
+review-vol と review-index では、文字数や行数、見込みページなど各値に大きな差が出ることがあります。これは、review-vol がごく簡単にファイルから概算しているのに対し、review-index は実際に内部でコンパイルして比較的精密に計量しているからです。
+
 ## プロジェクトフォルダを新しい Re:VIEW バージョンに追従する方法
 
 Re:VIEW は定期的に更新されています。おおむね後方互換性を保持していますが、新しいバージョン固有の機能を利用したいときには、プロジェクトフォルダを新しいバージョンに更新する review-update コマンドを利用します。
 
 ```bash
 $ review-update
-** review-update はプロジェクトを 4.0.0 に更新します **
-config.yml: 'review_version' を '4.0' に更新しますか? [y]/n ←Enterで実行
+** review-update はプロジェクトを 5.0.0 に更新します **
+config.yml: 'review_version' を '5.0' に更新しますか? [y]/n ←Enterで実行
 Rakefile は Re:VIEW バージョンのもの (/.../review/samples/sample-book/src/Rakefile) で置き換えられます。本当に進めますか? [y]/n
 lib/tasks/review.rake は Re:VIEW バージョンのもの (/.../review/samples/sample-book/src/lib/tasks/review.rake) で置き換えられます。本当に進めますか? [y]/n
 INFO: 新しいファイル /.../sty/plistings.sty が作成されました。
@@ -246,7 +259,7 @@ INFO: 新しいファイル /.../sty/gentombow.sty が作成されました。
 
 ## クレジット
 
-Re:VIEW は、青木峰郎によって最初に作成されました。武藤健志がこの開発・保守を引き継ぎ、2019年12月時点では、武藤健志、高橋征義、角征典が開発・保守を継続しています。
+Re:VIEW は、青木峰郎によって最初に作成されました。武藤健志がこの開発・保守を引き継ぎ、2020年10月時点では、武藤健志、高橋征義、角征典が開発・保守を継続しています。
 
 バグ・パッチの報告、その他の情報は、
 

data/doc/quickstart.md

@@ -9,7 +9,7 @@ Re:VIEW is free software under the terms of the GNU Lesser General Public Licens
 
 This article describes how to setup Re:VIEW and use it.
 
-The supported version of the article is Re:VIEW 4.0.
+The supported version of the article is Re:VIEW 5.1.
 
 ## Set up Re:VIEW
 
@@ -161,6 +161,16 @@ $ rake idgxml    ## generate InDesign XML
 
 There is a sample YAML file [config.yml.sample](https://github.com/kmuto/review/blob/master/doc/config.yml.sample) in the same directory of this document.
 
+#### generate PDF using Vivliostyle CLI
+
+Instead of using TeX (`review-pdfmaker` or `rake pdf`), you can also create a PDF use [Vivliostyle CLI](https://github.com/vivliostyle/vivliostyle-cli). Re:VIEW creates EPUB first and then converts it to PDF with Vivliostyle CLI.
+
+```bash
+$ rake vivliostyle:build    ## build PDF using Viliostyle
+$ rake vivliostyle:preview  ## preview pages in Chrome/Chromium browser
+$ rake vivliostyle          ## shortcut of vivliostyle:build
+```
+
 ### add chapters and modify them
 
 `catalog.yml` file is a catalog of Re:VIEW format files.
@@ -182,7 +192,6 @@ POSTDEF:
 
 The first item in CHAPS is the first chapter, and the second item (if you add) is the second chapter. PREDEF is for front matter, APPENDIX is for appendix, and POSTDEF is for back matter.  You can see in detail with [catalog.md](https://github.com/kmuto/review/blob/master/doc/catalog.ja.md).
 
-
 ### more information
 
 For more information about Re:VIEW format, see [format.md](https://github.com/kmuto/review/blob/master/doc/format.md).
@@ -223,17 +232,20 @@ $ review-vol
 You can also use `review-index` command to generate header list.
 
 ```bash
-$ review-index --level <heading level> -a
+$ review-index --level <heading level>
+$ review-index --level <heading level> -d  ## show volumes also
 ```
 
+review-vol and review-index can have large differences in the number of characters, lines, and pages. While review-vol only estimates from the file, review-index actually compiles and calculates.
+
 ## how to update the document folder to the new Re:VIEW version
 
 Re:VIEW is updated regularly. We Re:VIEW team watch the backward compatibility carefully, but if you want to use the features in the new version, you can use review-update command to update the project folder.
 
 ```bash
 $ review-update
-** review-update updates your project to 4.0.0 **
-config.yml: Update 'review_version' to '4.0'? [y]/n
+** review-update updates your project to 5.0.0 **
+config.yml: Update 'review_version' to '5.0'? [y]/n
 Rakefile will be overridden with Re:VIEW version (/.../review/samples/sample-book/src/Rakefile). Do you really proceed? [y]/n
 lib/tasks/review.rake will be overridden with Re:VIEW version (/.../review/samples/sample-book/src/lib/tasks/review.rake). Do you really proceed? [y]/n
 INFO: new file /.../sty/plistings.sty is created.
@@ -249,7 +261,7 @@ Finished.
 
 ## Copyright
 
-The original author of Re:VIEW is Minero Aoki. The current maintainer is Kenshi Muto(@kmuto), and committers are Masayoshi Takahashi and Masanori Kado (December 2019).
+The original author of Re:VIEW is Minero Aoki. The current maintainer is Kenshi Muto(@kmuto), and committers are Masayoshi Takahashi and Masanori Kado (March 2020).
 
 If you want to report bugs and patches, or to get more information, see: