ReVIEW
技術書
技術書典

技術系同人誌 Advent Calendarも4日目です。何か書いてみたくなりましたか?

技術系同人誌を書くときに選ばれる言語第1位と言っても過言ではないRe:VIEW
皆さんも使ってみませんか?ということでRe:VIEW記法のチートシートを作りました。

基本的にスペースは半角スペースです。その辺りは注意してください。

見出し

Markdownでいう「見出し1」は1ファイル1つしか使用できません。
また、見出し名の重複も許されません。

記述方法

= 見出し1(章)
== 見出し2(節)
=== 見出し3(項)
==== 見出し4(段)
===== 見出し5(章段)

記述例

= Re:VIEW記法チートシート

== これは見出し2です

=== これは見出し3です

==== これは見出し4です

===== これは見出し5です

文章の記述

1行あけて記述すると、段落が作成されます。
Re:VIEWファイル上で作成された段落は無視されます。

また、行の初めにはビルド時に全角スペースが入るため、字下げは不要です。
強制的に改行したい場合@<br>{}を用います。

記述方法

なにかもじをかく

一行あけると段落ができます

強制的に改行したい場合は@<br>{改行後のテキストはこちらに書きます}

記述例

りまりま団のもふもふです。プリキュアはYes!プリキュア5推しです。
のぞみちゃんは前向きで人への気遣いも忘れずで、本当にいい子だと思います。

敵キャラはカワリーノさん推しです。不憫でしんどいのがまたいいです。@<br>{グッズ出してくれー!}

あ、魔法使いプリキュア!とキラキラ☆プリキュアアラモードもおすすめだぞ!

強調

いくつか種類があります。

強調の種類 記述方法
太字 @<b>{テキスト}
イタリック @<i>{テキスト}
下線 @<u>{テキスト}

記述例

りまりま団のもふもふです。プリキュアは@<b>{Yes!プリキュア5}推しです。
のぞみちゃんは前向きで人への気遣いも忘れずで、本当にいい子だと思います。

敵キャラはカワリーノさん推しです。不憫でしんどいのがまたいいです。グッズ出してくれー!

あ、@<i>{魔法使いプリキュア!}と@<u>{キラキラ☆プリキュアアラモード}もおすすめだぞ!

箇条書きリスト

*を使うことでリストを作成できます。ネストの深さは*の数を使って指定します。
箇条書きの前後には空行を入れることが推奨されています。

記述方法

* リスト1
** リスト1のネスト
* リスト2
** リスト2のネスト

記述例

* Yes!プリキュア5に出てくるプリキュア
** キュアドリーム
** キュアルージュ
** キュアレモネード
** キュアミント
** キュアアクア
* 魔法使いプリキュア!に出てくるプリキュア
** キュアミラクル
** キュアマジカル
** キュアフェリーチェ

番号付きリスト

1. テキストと記述することで、番号付きリストを作成できます。
ネストには対応していません。

また、箇条書きの文字に強調を行うこともできます。

記述方法

1. リスト1
2. リスト2
3. リスト3

記述例

キラキラ☆プリキュアアラモードに出てくるプリキュア

1. キュアホイップ
2. キュアカスタード
3. キュアジェラート
4. キュアマカロン
5. @<b>{キュアショコラ}
6. キュアパルフェ

引用

段落が複数ある場合、空行を挿入します。

記述方法

//quote{
いんようするもの

いんようするもの
//}

記述例

『Go! プリンセスプリキュア』より

//quote{
咲き誇る花のプリンセス、キュアフローラ!
澄み渡る海のプリンセス、キュアマーメイド!
煌めく星のプリンセス、キュアトゥインクル!
真紅の炎のプリンセス、キュアスカーレット!

強く、優しく、美しく、Go!プリンセスプリキュア!
//}

リンクの挿入

方法はいくつかありますが、1番簡単な方法を紹介します。
技術書の執筆では@<href>{URL}を使うことが1番多くなるでしょう。

記述方法

URLをそのまま書く
@<href>{URL}

Markdownのように、文字にリンクをつける
@<href>{URL, 挿入される文章}

記述例

@<href>{http://www.toei-anim.co.jp/tv/yes_precure5/index.html}

@<href>{http://www.toei-anim.co.jp/tv/yes_precure5/index.html, Yes!プリキュア5}

画像の挿入

imageディレクトリを作成し、そこに画像を格納します。
ラベル名と画像名(拡張子以外)は合わせる必要があります。

scaleオプションは必須ではありません。
省略すると、そのままの大きさで出力されます。

画像に採番を行うか否かで使用する記法が変わりますので注意してください。

記述方法

採番する場合
//image[ラベル名][タイトル]{
//}

画像の大きさを調整する
//image[ラベル名][タイトル][scale=0.5]{
//}

採番しない場合
//indepimage[ラベル名][タイトル]{
//}

記述例

画像名は「プリプリお手玉」として保存しておきます。

//image[otedama][プリプリお手玉]{
//}

画像の大きさを0.5倍にする場合

//image[otedama][プリプリお手玉][scale=0.5]{
//}

連番なしで画像を挿入したい場合

//indepimage[otedama][プリプリお手玉]{
//}

挿入した画像の引用

記述方法

連番がない(indepimage)画像は引用することができません。

@<img>{ラベル}

記述例

@<img>{otedama}は、プリプリお手玉といいます。

表の挿入

記述方法

行は改行で区切ります。
セル間はタブ区切りです。半角スペースだと効かないので注意です。
空白セルはピリオドを入力します。
セルにピリオドを入力する場合は、ピリオドを2つ入れれば良いです。

------で区切ると、明確にヘッダを指定することが可能です。

記述例

//table[precure_table][プリキュアの放送年とタイトル]{
年 放送タイトル
----------
2004    ふたりはプリキュア
2005    ふたりはプリキュア Max Heart
2006    ふたりはプリキュア Splash Star
2007    Yes!プリキュア5
2008    Yes!プリキュア5GoGo!
2009    フレッシュプリキュア!
2010    ハートキャッチプリキュア!
2011    スイートプリキュア♪
2012    スマイルプリキュア!
2013    ドキドキ!プリキュア
2014    ハピネスチャージプリキュア!
2015    Go!プリンセスプリキュア
2016    魔法使いプリキュア!
2017    キラキラ☆プリキュアアラモード
//}

挿入した表の引用

記述方法

@<table>{ラベル名}を使用すると、表の名称を引用することができます。

記述例

今まで放送されたプリキュアの一覧は@<table>{precure_table}を参照してください。

コードの挿入

記述方法その1

文中に短いコードを挿入する場合@<code>{テキスト}を使用します。

記述例

Markdownで文字を強調したい場合、@<code>{**プリキュア**}のように@<code>{**}で強調対象を挟みます。

記述方法その2

リード文を使用して、コードを挿入します。
記法は次の通りです。

//lead{
テキスト
//}

記述例

番号付きリストの記法を紹介する場合

//lead{
== 番号付きリスト

キラキラ☆プリキュアアラモードに出てくるプリキュア

1. キュアホイップ
2. キュアカスタード
3. キュアジェラート
4. キュアマカロン
5. @<b>{キュアショコラ}
6. キュアパルフェ
//}

記述方法その3

コマンドラインの出力結果を使用する場合、次の記法を使うと良いです。

//cmd{
テキスト
//}

記述例

//cmd{
$ precure
-bash: precure: command not found
//}

注釈

記述方法

//footnote[ラベル名][注釈の中身]で注釈を記述し、@<fn>{ラベル名}で注釈を文中に挿入します。

記述例

キラキラ☆プリキュアアラモードで子供達に人気があるのはキュアマカロンです@<fn>{fn01}。
//footnote[fn01][お姉さんキャラは子供に人気がでやすい、というのは過去シリーズでも同傾向がみられます。]

コメント

記述方法

#@#で始めた文章は全てコメントアウトされます。

記述例

#@#はープリキュアシリーズはどれも最高かよ

以上、代表的な記法の紹介でした。ちょっとずつ追記するかもしれないです。
あと、ビルド後の出力結果も載せたいなー。

みんなもプリキュアみてくれよなーっ!