Instantly share code, notes, and snippets.

@erukiti /review.md
Last active Oct 17, 2018

Embed
What would you like to do?
Re:VIEWチートシート

Re:VIEWチートシート

いつもいつもいつもRe:VIEWの記法に悩んでぐぐってしまう皆さんへ送るチートシートです。

基本

名称 ルール 概要・備考
段落 1行以上の空行をはさむと別の段落になる HTMLでいうP
見出し =ではじまる行 =の個数で、章・節・項・段という感じで増えます。HTMLで言うH1, H2, H3, H4, H5
コラム ====[column]の行から====[/column]の行まで =の個数はあまり気にせず4決め打ちとかでもOK
箇条書き 空白と*で始まる行 先頭に空白を忘れないことと、ネストは、** のように重ねること
コメント #@# ではじまる行 コメント
プリプロセッサ命令 review-preprocを叩くことで#@mapfile(ファイル名)の行から#@end 外部ファイルを取り込む。サンプルソースなどに大活躍
段落1

段落2

段落3

= 章見出し(H1)

== 説見出し(H2)

見出しの前後は空行にしておいた方が無難です。

 * 箇条書き
 * かじょうがき

#@# コメント
#@# FIXME: これからすごい大作を執筆する

//listnum[source-code][ソースコード]{
#@mapfile(sample/chap-sugoi/friends.js
#@end
//}

====[column] エモくコラムを語る

コラム本文

====[/column]

大体これも命令行の前後は開けておく方が無難。Re:VIEW様の機嫌を損ねてはいけない。

ブロック命令

命令 引数 概要・備考
//listnum [ID][キャプション][言語(省略可能)] プログラミング関連なら一番よく使うリスト表記
//list [ID][キャプション][言語(省略可能)] 行番号なしリスト
//emlist [キャプション(省略可能)][言語(省略可能)] リスト番号が付かない (キャプションの省略も可能) リストで、行番号なし
//emlistnum [キャプション(省略可能)][言語(省略可能)] リスト番号が付かない (キャプションの省略も可能) リストで、行番号あり
//cmd なし コマンドライン操作専用のリスト。listnumでも問題なし。ちょっとわかりやすいくらい
//image [ID][キャプション][オプション(省略可能)] オプションでよく使うのはscale=0.5など(横幅に対するスケーリング比率)
//table [ID][キャプション] 表のセル区切りはハードタブ、空白のセルは.で表現
//quote なし 引用
//footnote [ID][中身] 脚注
//bibpaper [ID][キャプション] 参考文献
//lead なし リード文
//listnum[sample][サンプル][js]{
const hoge = 'ほげ'

// javascript でっせー

console.log(hoge)
//}

というようなサンプルソース@<list>{sample}を書いてみました。
//cmd{
$ sudo rm -rf /
//}
//image[sugoi][すごい画像]
//table[camp][キャンプ]{
名称  説明
----------------------------
志摩りん  ソロキャンパー。でも最近なでしこに浸食されてみんなでキャンプを楽しむのも悪くないと思ってる
各務原なでしこ  美味しそうにメシを食う。ひたすら食う。とにかく食う。やたら元気
斉藤恵那  熊とトラとチワワ100匹を放ってりんちゃんを殺そうとした女。でも空腹で返り討ちに合う
大垣千明  男前めがね
犬山あおい  関西弁(の影響の強い岐阜県民らしい)
//}

ハードタブ区切りであることに注意。
//quote{
なんか名言っぽいヤツとか
//}
//footnote[fuga][ふがー]
//bibpaper[bible][ばいーぼ]
//lead{
なんか冒頭にあるやつ。不思議の国のアリスとかから引用するとそれっぽい
//}

インライン命令

命令 概要・備考
@<tt>{...} 等幅
@<code>{...} ソースコードを本文に貼り付ける時に使用。等幅。
@<list>{ID} リストを参照する (対応: list, listnum, emlist, emlistnumなど)
@<img>{ID} 図を参照する (対応: image, indepimageなど)
@<table>{ID} 表を参照する
@<fn>{ID} 脚注を参照する
@<bib>{ID} 参考文献を参照する
@<chap>{章ID} chap, title, chapref など、章番号・タイトル・その組み合わせに変換される
@<column>{コラムID} コラムを参照する
@<href>{URL} ハイパーリンクを貼る (PDFやepubで有効)

@<tt>{...}と@<code>{...}の使い分けは、変数名など名前空間のあるものや識別子、演算子などにソースコードを表現するなど。でもLaTeXを初めとして大半はコンパイル結果はttとcodeで同じになる。HTMLの時だけスタイルシートで変更可能

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment