【書籍制作ワークフロー】ReVIEW 入門 #06 – ReVIEW 記法 (インライン)

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

前回に引き続き、ReVIEW 記法について学んでいきます。今回はインラインの記法と HTML での出力結果を学んでいくとします。

ReVIEW 記法 - インライン

段落中の任意の文字に対して特別な文法を付与することが出来ます。

ソースコードリストを参照

対象となるソースコードリストの連番文字列に変換されます

ReVIEW
//list[list][リストのサンプル]{
int main(int argc, char **argv) {
  puts("OK");
  return 0;
}
//}

..は@<list>{list}をみてください。
HTML
<p class="caption">リスト1.1: リストのサンプル</p>
<pre class="list">int main(int argc, char **argv) {
  puts("OK");
  return 0;
}
</pre>
</div>

<p>..はリスト1.1をみてください。</p>

画像を参照

対象となる画像の連番文字列に変換されます。

ReVIEW
//image[imgsample][画像サンプル]{
//}

本文中で@<img>{imgsample}を指定します。
HTML
<div class="image">
  <img src="images/sample-imgsample.jpg" alt="画像サンプル" />
  <p class="caption">図1.1: 画像サンプル</p>
</div>

<p>本文中で図1.1を指定します。</p>

テーブルを参照

対象となるテーブルの連番文字列に変換されます。

ReVIEW
//table[envvars][重要な環境変数]{
名前			意味
-------------------------------------------------------------
PATH	コマンドの存在するディレクトリ
TERM		使っている端末の種類。linux・kterm・vt100など
LANG	ユーザのデフォルトロケール。日本語ならja_JP.eucJPやja_JP.utf8
LOGNAME	ユーザのログイン名
TEMP	一時ファイルを置くディレクトリ。/tmpなど
PAGER	manなどで起動するテキスト閲覧プログラム。lessなど
EDITOR	デフォルトエディタ。viやemacsなど
MANPATH	manのソースを置いているディレクトリ
DISPLAY	X Window Systemのデフォルトディスプレイ
//}

段落中で@<table>{envvars}を指定します。
HTML
<div class="table">
  <p class="caption">表2.1: 重要な環境変数</p>
  <table>
    <tr><th>名前</th><th>意味</th></tr>
    <tr><td>PATH</td><td>コマンドの存在するディレクトリ</td></tr>
    <tr><td>TERM</td><td>使っている端末の種類。linux・kterm・vt100など</td></tr>
    <tr><td>LANG</td><td>ユーザのデフォルトロケール。日本語ならja_JP.eucJPやja_JP.utf8</td></tr>
    <tr><td>LOGNAME</td><td>ユーザのログイン名</td></tr>
    <tr><td>TEMP</td><td>一時ファイルを置くディレクトリ。/tmpなど</td></tr>
    <tr><td>PAGER</td><td>manなどで起動するテキスト閲覧プログラム。lessなど</td></tr>
    <tr><td>EDITOR</td><td>デフォルトエディタ。viやemacsなど</td></tr>
    <tr><td>MANPATH</td><td>manのソースを置いているディレクトリ</td></tr>
    <tr><td>DISPLAY</td><td>X Window Systemのデフォルトディスプレイ</td></tr>
  </table>
</div>

<p>段落中で表2.1を指定します。</p>

脚注番号

脚注番号に置換されます。番号は ReVIEW 側で自動採番されます。

ReVIEW
jQuery Mobile を一度でも触ったことのある方なら、その用途は何となく理解できるのではないでしょうか@<fn>{note2}。

//footnote[note2][あまり知らないという方、より詳しく知りたいという方は、@<href>{http://www.html5.jp/tag/attributes/data.html, こちらのサイト}をご参照ください。]
HTML
<p>jQuery Mobile を一度でも触ったことのある方なら、その用途は何となく理解できるのではないでしょうか<a href="#fn-note2" class="noteref">*1</a>。</p>

<div class="footnote">
  <p class="footnote">[<a id="fn-note2">*1</a>] あまり知らないという方、より詳しく知りたいという方は、<a href="http://www.html5.jp/tag/attributes/data.html" class="link">こちらのサイト</a>をご参照ください。</p>
</div>

キーワード

ReVIEW
@<kw>{信任状, credential}は持ってきましたか?
HTML
<b class="kw">信任状 (credential)</b><!-- IDX:信任状 -->は持ってきましたか?

章番号

ReVIEWファイル名を指定することで、それに該当する章番号に置換します。

ReVIEW
@<chap>{sample02}
HTML
第2章

章題

ReVIEWファイル名を指定することで、それに該当する章題に置換します。

ReVIEW
= ReVIEW 記法 - インライン

@<title>{sample02}
HTML
<h1><a id="h2"></a>第2章 ReVIEW 記法 - インライン</h1>

<p>ReVIEW 記法 - インライン</p>

章番号 + 章題

ReVIEW ファイル名を指定することで、それに該当する章番号と章題に置換します。

ReVIEW
= ReVIEW 記法 - インライン

@<chapref>{sample02}
HTML
<h1><a id="h2"></a>第2章 ReVIEW 記法 - インライン</h1>

<p>第2章「ReVIEW 記法 - インライン」</p>

傍点

ReVIEW
@<bou>{ふさわしい}
HTML
<span class="bou">ふさわしい</span>

ルビ(ふりがな)

第一引数に渡した文字列のルビを第二引数に渡します。

ReVIEW
ぼくの名前は@<ruby>{wakamsha, わかむしゃ}です。
HTML
ぼくの名前は<ruby><rb>wakamsha</rb><rp>(</rp><rt> わかむしゃ</rt><rp>)</rp></ruby>です。

網掛け

ReVIEW
ここは@<ami>{テストに出ます}。
HTML
ここは<span class="ami">テストに出ます</span>。

太字(ボールド)

ReVIEW
@<b>{どうしても}
HTML
<b>どうしても</b>

イタリック

ReVIEW
@<i>{どうしても}
HTML
<i>どうしても</i>

強調文字

ReVIEW
@<strong>{どうしても}

@<em>{どうしても}
HTML
<strong>どうしても</strong>

<em>どうしても</em>

等幅フォント

主に段落中にプログラムコード等を含めたい場合などに使用します。

標準

ReVIEW
@<tt>{bundle install}
HTML
<tt>bundle install</tt>

イタリック

ReVIEW
@<tti>{bundle install}
HTML
<tt><i>bundle install</i></tt>

太字(ボールド)

ReVIEW
@<ttb>{bundle install}
HTML
tt><b>bundle install</b></tt>

下線(アンダーライン)

ReVIEW
@<u>{アンダーライン}
HTML
<u>アンダーライン</u>

改行

段落内で改行したいときに使用します。

ReVIEW
お世話になっております。@<br>{}wakamshaです。
HTML
お世話になっております。<br />wakamshaです。

TeX インライン式

ReVIEW
@<m>{a + alpha}
HTML
<span class="equation">a + alpha</span>

段落内画像

段落(文章)の途中で画像を差し込むときに使います

ReVIEW
例えばこのような@<icon>{imgsample}があったとします。
HTML
例えばこのような<img src="images/sample-imgsample.jpg" alt="[imgsample]" />があったとします。

Unicode 文字の出力

引数は16 進数で指定します。

ReVIEW
@<uchar>{2460}
HTML

ハイパーリンク

第一引数に URL を指定し、第二引数に表示したい文字列を指定します。第二引数を省略したときは、第一引数のパラメータがそのまま表示されます。

ReVIEW
@<href>{www.google.com/}

@<href>{www.google.com/, Google検索ページ}
HTML
<a href="www.google.com/" class="link">www.google.com/</a>

<a href="www.google.com/" class="link">Google検索ページ</a>