doc/format.ja.md in review-5.2.0 vs doc/format.ja.md in review-5.3.0

- old
+ new

@@ -1,10 +1,10 @@ # Re:VIEW フォーマットガイド Re:VIEW フォーマットの文法について解説します。Re:VIEW フォーマットはアスキー社(現カドカワ)の EWB を基本としながら、一部に RD や各種 Wiki の文法を取り入れて簡素化しています。 -このドキュメントは、Re:VIEW 5.1 に基づいています。 +このドキュメントは、Re:VIEW 5.3 に基づいています。 ## 段落 段落(本文)の間は1行空けて表現します。空けずに次の行を記述した場合は、1つの段落として扱われます。 @@ -394,11 +394,11 @@ * Graphviz ( https://www.graphviz.org/ ) : `dot` コマンドへのパスを OS に設定すること * Gnuplot ( http://www.gnuplot.info/ ) : `gnuplot` コマンドへのパスを OS に設定すること * Blockdiag ( http://blockdiag.com/ ) : `blockdiag` コマンドへのパスを OS に設定すること。PDF を生成する場合は ReportLab もインストールすること * aafigure ( https://launchpad.net/aafigure ) : `aafigure` コマンドへのパスを OS に設定すること -* PlantUML ( http://plantuml.com/ ) : `java` コマンドへのパスを OS に設定し、`plantuml.jar` が作業フォルダにあること +* PlantUML ( http://plantuml.com/ ) : `java` コマンドへのパスを OS に設定し、`plantuml.jar` が作業フォルダ、または `/usr/share/plantuml` あるいは `/usr/share/java` フォルダにあること ## 表 表は `//table[識別子][キャプション]{ 〜 //}` という記法です。ヘッダと内容を分ける罫線は「`------------`」(12個以上の連続する `-` または `=`)を使います。 @@ -522,10 +522,11 @@ 例: ``` パッケージは本書のサポートサイトから入手できます@<fn>{site}。 各自ダウンロードしてインストールしておいてください。 + //footnote[site][本書のサポートサイト: http://i.loveruby.net/ja/stdcompiler ] ``` 本文中のインライン命令「`@<fn>{site}`」は脚注番号に置換され、「本書のサポートサイト……」という文は実際の脚注に変換されます。 @@ -536,10 +537,35 @@ `footnotetext` オプションを使うには、`config.yml` ファイルに`footnotetext: true` を追加します。 ただし、通常の脚注(footnote)ではなく、footnotemark と footnotetext を使うため、本文と脚注が別ページに分かれる可能性があるなど、いろいろな制約があります。また、採番が別々になるため、footnote と footnotemark/footnotetext を両立させることはできません。 +## 後注 + +後注(最後にまとめて出力される注釈)は、「`//endnote`」を使って記述します。 + +``` +パッケージは本書のサポートサイトから入手できます@<endnote>{site}。 +各自ダウンロードしてインストールしておいてください。 + +//endnote[site][本書のサポートサイト: http://i.loveruby.net/ja/stdcompiler ] +``` + +本文中のインライン命令「`@<endnote>{site}`」は後注番号に置換され、「本書のサポートサイト……」という文は後注として内部に保存されます。 + +保存されている後注を書き出すには、書き出したい箇所(通常は章の末尾)に「`//printendnotes`」を置きます。 + +``` + … + +==== 注釈 + +//printendnotes +``` + +後注の管理は章 (re ファイル) 単位であり、複数の章にまたがった後注を作ることはできません。 + ## 参考文献の定義 参考文献は同一ディレクトリ内の `bib.re` ファイルに定義します。 ``` @@ -684,10 +710,10 @@ ``` math_format: imgmath imgmath_options: format: svg - pdfcrop_pixelize_cmd: "pdftocairo -svg -r 90 -f %p -l %p -singlefile %i %o" + pdfcrop_pixelize_cmd: "pdftocairo -%t -r 90 -f %p -l %p %i %o" ``` デフォルトでは、pdfcrop_pixelize_cmd に指定するコマンドは、1ページあたり1数式からなる複数ページの PDF のファイル名を `%i` プレースホルダで受け取り、`%p` プレースホルダのページ数に基づいて `%o`(拡張子あり)または `%O`(拡張子なし)の画像ファイルに書き出す、という仕組みになっています。 単一のページの処理を前提とする `sips` コマンドや `magick` コマンドを使う場合、入力 PDF から指定のページを抽出するように `extract_singlepage: true` として挙動を変更します。単一ページの抽出はデフォルトで TeXLive の `pdfjam` コマンドが使われます。