Re:VIEWとは自動組版をおこなってくれる執筆支援ツールです。Re:VIEW(旧:ReVIEW)共にキーワードがあまりにも一般的すぎて、公式にkmuto ReVIEW
で検索してくださいとつぶやかれていました。
また、Re:VIEWの開発環境がMacということもあり、Windowsへの導入は少々難易度が高いですが、インストールさえしてしまえば、後の使い方については差異はありません(と思います)。
導入
Windows 8.0/8.1(64bit版)にReVIEWが稼働する環境を導入します。
基礎
ReVIEWではWikiやmarkdownに似た独自の記法を用いて原稿を書きます。ReVIEW記法について逆引き的に紹介します。
- ReVIEW記法でコラムを挿入する
- ReVIEW記法でリスト(ソースコード)を挿入する
- ReVIEW記法で引用を挿入する
- ReVIEW記法で表を挿入する
- ReVIEW記法で他のreファイルの章番号や章題(タイトル)に置換する
応用
PDF作成時などコンフィグファイル(yamlファイル)にて詳細を指定することが可能です。config.yamlの設定の仕方を逆引き的に紹介します。
運用
最近はもっぱら複数人数で原稿を執筆することが多くなってきました。それぞれが持っている原稿が古い場合など整合性が取れない可能性が出てきます。原稿をバージョン管理し、その原稿をReVIEWによってPDF/epubに変換しますが、それをJenkinsを使ったCIしてみましょう。
トラブルシューティング
- Re:VIEWの「review-pdfmaker」を実行すると稀にPDFが尻切れトンボになる
- MS-DOSスタイルのパスが原因でCygwinでワーニングが発生する(Windows環境)
- ○章以降の記事が出力されていない
- imageタグ以降の記事が出力されていない
- //TODO と書いたところワーニング表示された
- ==と===を続けて書いたら===の節が出力されなかった