doc/format.ja.md in review-4.2.0 vs doc/format.ja.md in review-5.0.0

- old
+ new

@@ -1,10 +1,10 @@ # Re:VIEW フォーマットガイド Re:VIEW フォーマットの文法について解説します。Re:VIEW フォーマットはアスキー社(現カドカワ)の EWB を基本としながら、一部に RD や各種 Wiki の文法を取り入れて簡素化しています。 -このドキュメントは、Re:VIEW 3.0 に基づいています。 +このドキュメントは、Re:VIEW 5.0 に基づいています。 ## 段落 段落(本文)の間は1行空けて表現します。空けずに次の行を記述した場合は、1つの段落として扱われます。 @@ -253,11 +253,10 @@ //listnum[hello][ハローワールド][ruby]{ puts "hello world!" //} ``` - ### ソースコード専用の引用 ソースコードを引用するには次のように記述します。 例: @@ -501,10 +500,23 @@ いずれも `[キャプション]` は省略できます。 内容には、空行で区切って複数の段落を記述可能です。 +Re:VIEW 5.0 以降では、囲み記事に箇条書きや図表・リストを含めることもできます。 + +``` +//note{ + +箇条書きを含むノートです。 + + 1. 箇条書き1 + 2. 箇条書き2 + +//} +``` + ## 脚注 脚注は「`//footnote`」を使って記述します。 例: @@ -587,11 +599,11 @@ ``` 「式1.1」のように連番を付けたいときには、識別子とキャプションを指定します。 ``` -//texequationl[emc][質量とエネルギーの等価性]{ +//texequation[emc][質量とエネルギーの等価性]{ \sum_{i=1}^nf_n(x) //} ``` 参照するにはインライン命令 `@<eq>` を使います(たとえば `@<eq>{emc}`)。 @@ -910,11 +922,78 @@ ここは特別なブロックとして扱われます </div> ``` - `//raw`、`//embed`、`@<raw>` および `@<embed>` は、HTML、XML や TeX の文書構造を容易に壊す可能性があります。使用には十分に注意してください。 + +### 入れ子の箇条書き + +Re:VIEW の箇条書きは `*` 型の箇条書きを除き、基本的に入れ子を表現できません。いずれの箇条書きも、別の箇条書き、あるいは図表・リストを箇条書きの途中に配置することを許容していません。 + +この対策として、Re:VIEW 4.2 では試験的に `//beginchild`、`//endchild` というブロック命令を追加しています。箇条書きの途中に何かを含めたいときには、それを `//beginchild` 〜 `//endchild` で囲んで配置します。多重に入れ子にすることも可能です。 + +``` + * UL1 + +//beginchild +#@# ここからUL1の子 + + 1. UL1-OL1 + +//beginchild +#@# ここからUL1-OL1の子 + +UL1-OL1-PARAGRAPH + + * UL1-OL1-UL1 + * UL1-OL1-UL2 + +//endchild +#@# ここまでUL1-OL1の子 + + 2. UL1-OL2 + + : UL1-DL1 + UL1-DD1 + : UL1-DL2 + UL1-DD2 + +//endchild +#@# ここまでUL1の子 + + * UL2 +``` + +これをたとえば 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> +``` + +(試験実装のため、命令名や挙動は今後のバージョンで変更になる可能性があります。) ## インライン命令 主なインライン命令を次に示します。 ### 書体