第 3 章 Re:VIEW の書き方 インライン命令 インライン命令は @く命令 > {... } のように、 @ ( アットマーク ) に続けて括弧 < > 内に 命令名を指定します。続く括弧 { } の中が、インライン命令の効果が及ぶ範囲になります。 インライン命令は、文章の装飾やリストや図の参照など表示や内容に影響します。文中 に直接記人することができますが、改行をまたぐことはできません。 / / 命令 { マリスト 3.2 プロック命令 プロック命令 プロック命令はリスト 3.2 のように、スラッシュ 2 つ ( / / ) に続けて命令名を指定しま す。続く括弧 { から、次の / / } までが、プロック命令の効果が及ぶ範囲になります。 プロック命令はリストや図など本文とは独立した内容を掲載する際に使います。 / / 命令 [ オプション 1 ] [ オプション 2 ] [ オプション 3 ] { V リスト 3.3 プロック命令 指定可能なオプションの数や省略の可否は、命令によって違います。 に続けて括弧 [ ] の中に記述します ( リスト 3.3 ) 。 プロック命令には複数のオプションを指定できる場合があります。オプションは、命令 20 リスト 3.4 キャプションと対応 の 5 段階に対応します ( リスト 3.4 ) 。 = の数によって見出しの深さが変わります。数に応じてそれぞれ章、節、項、段、小段 = は、必ず行頭から開始します。また、 = の後ろには、必ず半角スペースを入れます。 見出しは、 = から始めて、キャプションを続けます。 見出し 行をプロック命令として扱いません。 は、必ず行頭に記述します。行頭に半角スペースなどが人った場合、 Re:VIEW は、その プロック命令を文の途中から開始することはできません。プロック命令の開始と終了

3.2 プリプロセッサ命令 キーワードと解説 また文字の装飾は、本文だけでなくリストや脚注、表などの中でも有効です。利用頻度 文字の装飾は適用したい範囲を @く修飾子 > {... } で指定するだけです。 Re:VIEW 記法では文字を装飾することができます。 文字の装飾 の高い文字の装飾について表 3.3 にまとめています。 Y 表 3.3 文字の装飾 修飾子 @ < b > { 文字列 } @ < i > { 文字列 } @ < tt > { 文字列 } @ く ttb > { 文字列 } @<tti>{ 文字列 } @ く em > { 文字列 } @<strong>{ 文字列 } @ く ami > { 文字列 } @ <kw> { キーワード , 解説 } 説明 イタリック & 等幅フォント 太字 ( ポールド ) & 等幅フォント 等幅フォント イタリックフォント 太字 ( ポールド ) フォント 網掛け 強調 強調 例 GNU (GNU is Not Unix) abcdefg, あいうえお、 abcdefg あいうえお abcdefg あいうえお abcdefg あいうえお abcdefg あいうえお abcdefg あいうえお 勧司 q 力あいうえお abcdefg あいうえお 32 プリプロセッサ命令 Re:VIEW では、最終的な見た目に影響する記法とは別に、外部の情報を . re ファイル 35 w—preproc コマンドは #@mapfile(file name) と #@e Ⅱ d の間にファイル file name を む箇所に #@mapfile(file-name) と読み込み範囲の終了示す #@e Ⅱ d を記述します。 revie mapfile 命令は、外部ファイルの内容をすべて読み込みます。外部ファイルを読み込 ファイルの内容を読み込む に . re ファイルの内容がビルドされることに変わりはありません。 プリプロセッサ命令は、あくまで . re ファイルの一部を書き換えるだけです。最終的 「 7.4 タスクランナーの設定」を参照してください。 w-preproc コマンドは、 PDF のビルド時に自動で実行するようにしておくと便利です。 プリプロセッサ命令を処理するには review ー prepr 。 c コマンドを使用します。 revie ファイルとしているサンプルコードを自動で . re ファイル内に反映できます。 に反映する「プリプロセッサ命令」があります。プリプロセッサ命令を使うことで、外部

第 3 章 Re:VIEW の書き方 本章では Re:VIEW の記法を紹介します。執筆にあたって適切なマークアップ を選択できるよう、利用頻度の高い Re : VIEW 記法について扱います。 3 記法の紹介 また、画像やプログラムリストを掲載する場合、視覚的に区別しやすくし、本文に対し適切な余白をと v リスト 3.1 通し番号の割り当て十キャプションを表示 を自動的にするための仕組みがあります ( リスト 3.1) 。 ト 2.1 」などのように番号を振る必要がありますが、 Re:VIEW にはリストや図版の採番 また、文章中でコード例や図版を挿人した時、文中からそれらを参照するために「リス 一般的に行われています。 ドの名前を記述する場合、等幅フォントにしたりすることで、視覚的に差別化することは す。たとえば技術書では、文章や単語を強調したいときに太字にしたり、クラスやメソッ Re:VIEW 記法は、文章を書き、見出しやコードなどをマークアップするための記法で インライン命令とプロック命令 てより良い情報になります。 す。マークアップの巧拙が表現力の差となります。そして、より良い表現は、祝者にとっ Re : VIEW 記法でマークアップすることで文章の構造や見た目を記述することができま り、適切な場所に配置することも大切です。 19 Re:VIEW 記法は、「インライン命令」と「プロック命令」の 2 つに分類できます。

3.2 プリプロセッサ命令 出力結果のインデントを調整で ew—compile コマンドの tabwidth オプションを使えは、、 きます。 ファイルの内容の一部を読み込む maprange 命令は、外部ファイルの一部を読み込みます。ただし、外部のファイル側に 読み込み範囲を示すプリプロセッサ命令を記述しておく必要があります。 #@range-begin(range-name) と #@range-end(range-name) で範囲を括ります。リ スト 3.34 は、 #@range_begin(range_name) と #@range_end(range_name) を記述した #@end #@maprange(src.txt , sample) //list[sample-code] [ サンプルコード ] { リスト 3.35 コンノヾイル前の maprange 記述 します。また、 #@maprange ( ・ リスト 3.34 で指定した範囲を読み込むには、 . re ファイルにリスト 3.35 のように記述 ここは読み込みません。 #@range-end (sample) ここを読み込みます。 #@range—begin(sample) ここは読み込みません。 マリスト 3.34 maprange で読み込む src. txt 例です。 . ) は #@map ( ... ) と記述しても動作します。 37 #@end ここを読み込みます。 #@maprange(src . txt , sample) //list[sample-code] [ サンプルコード ] { ▽リスト 3.36 コンバイル後の maprage リスト 3.35 は review-preproc コマンドの処理後にリスト 3.36 のようになります。

第 3 章 Re:VIEW の書き方 外部コマンドの結果を読み込む mapoutput 命令は、外部コマンドの結果を読み込みます。この命令は Re:VIEW の記 法の枠内に囚われず、任意の処理の結果を . re ファイルに埋め込めます。しかし、あくま でコンパイルするマシンにインストールしているコマンドを使用するため、複数人で執筆 する場合は注意が必要です。 たとえば、筆者の環境の java のバージョンを自動で埋め込む場合はリスト 3.37 のよう に記述します。 ▽リスト 3.37 java -version #@mapoutput (j ava —version 2 > & 1 ) #@end リスト 3.37 は、コンパイル後にリスト 3.38 のようになります。 マリスト 3.38 java -version #@mapoutput (j ava —version 2 > & 1 ) Java version " 1 . 8 . 0 ー 05 " Java(TM) SE Runtime Environment (build 1 . 8 . 0 ー 05 ー b13 ) Java HotSpot(TM) 64—Bit Server VM (build 25 . 5 ー b02 , mixed mode) #@end 38

第 3 章 Re:VIEW の書き方 み込みます。 たとえばサンプルコード foo. rb を読み込む場合、リスト 3.32 のように記述します。 リスト 3.32 コンパイル前の mapfile 記述 //list [sample-code] [ サンプルコード ] { #@mapfile(foo.rb) #@end リスト 3.32 は review-preproc コマンドの処理後にリスト 3.33 のようになります。 Re:VIEW は #@~ の行を PDF や HTML ファイルなどの最終的な成果物には出力せず、 foo. rb の内容だけを出力します。 リスト 3.33 コンパイル後の mapfile 記述 //list[sample-code] [ サンプルコード ] { #@mapfile(foo.rb) puts ” f00 " #@end tabwidth オプション review-preproc コマンドは tabwidth オプションを使うと、プリプロセッサ命令で読 み込むファイルのタブ文字を任意の数のスペースに置換します。 紙面の都合上、 TechBooster ではサンプルコードのインデントは 2 スペースとしていま す。しかし、サンプルコードを最初から 2 スペースのインデントで書くというのはあまり やりたくありません。タブ文字でインデントしておけば原稿に反映する際に自動でインデ ントの文字幅を置換できます。サンプルコードを編集するエデイタ上ではタブ文字を好み の幅で表示しましよう。 tabwidth オプションは --tabwidth=WIDTH という形式で指定します。たとえば、 sam- ple. re に対して review ー prepr 。 c コマンドを実行しタブ文字を 2 スペースに置換するに は、次のようにします。 このオプションが効くのは、あくまでプリプロセッサ命令で読み込むファイルの内容の みです。 mapfile などを使わず list プロック内に直接コードを書いている場合は、 revi $ review—preproc —r ——tabwidth=2 sample. re 36

目次 はじめに お間い合わせ先 免責事項 . 第 1 章 技術書を書くための要求 1.1 Re:VIEW とは 1.2 本を作るための技術的要求 . 1.3 TechBooster が「 Re:VIEW 」を勧める理由 1.4 同人誌向けの Re : VIEW 構成を使用する 第 2 章 環境を整える 2.1 Atom と language-review のセットアップ 2.2 Re:VIEW をインストールする PDF 出力を準備する . Docker とは ? Docker を使ってどこでもビルド 第 3 章 Re:VIEW の書き方 記法の紹介 3.1 3.2 プリプロセッサ命令 設定ファイルの解説 第 4 章 4.1 章を設定する catalog. yml メタデータを記述する config. yml 4.2 4.3 ページサイズを変更する 目次に表示する項目をカスタマイズする . 4.4 コンバイルの仕方 第 5 章 1 1 一 4 冖ー ( ト一 1 1 ー亠 11 -1 11 9 5 1 11 9 一 9 一【い】 1 ワ」 3 " 4 ・ 4 ・ 4 44 4