📖

Re:VIEW執筆方法Tips

2023/05/19に公開

Re:VIEWで技術同人誌作成

第八回 技術書同人誌博覧会に出展予定です。

https://karaage.hatenadiary.jp/entry/2023/05/15/073000

書籍作成のためにRe:VIEWというソフトを使っているので使い方のメモです。

Re:VIEW環境構築

以下の通りです。

https://zenn.dev/karaage0703/articles/52be7d25f7d76b

執筆にはVS Codeエディタを使う前提です。日本語入力環境は以下記事のとおりセットアップしています。

https://karaage.hatenadiary.jp/entry/2021/04/19/073000

執筆Tips

VS Code設定

  • 折返し表示はALT + Zで切り替えます

図関係

  • articleディレクトリ下のimagesディレクトリに画像を入れます(デフォルト設定)。例えば章ごとにディレクトリ分けたりもできますが、私は全部imagesに入れました。

  • 例えば images ディレクトリのsample.jpgという図を表示するときは、以下のような書式になります。ディレクトリや拡張子は指定しちゃだめです。ファイル名のみ識別子として入れられます。コメントもつけれますが、私は使っていません。

//image[sample][サンプル]
  • 図を参照するときは以下です
@<img>{sample}
  • 図は画面いっぱいに広がってしまう。小さくするときは、scaleで指定します。ただ、プレビューには反映されないのでビルドして確認するしかない(なぜ)。
//image[sample][サンプル][scale=0.5]

文章ファイル関係

  • 文章ファイルは、章ごとに分ける必要があるトップレベルヘッダー('= title')が1つのファイルに1つしかつけられません。章のファイルはcatalog.yamlファイルで定義します。トップレベルヘッダーが複数あると、コンパイル(pdf作成)も、VS Codeエディタでのプレビューもできなくなります。

  • 同じヘッダー(見出し)の名前があるとコンパイルもプレビューもできなくなります。以下みたいにラベルをつける必要があります。

==={label_A} テスト

==={label_B} テスト

コマンドの表記

  • 以下のように書けばOKです。
//cmd{
$ ls
//}

imagetableがプレビューできない

  • 画像を表として貼りたいとき、以下のようにimgtableを使います。オプションは自分の環境だと必須でした(ないとコンパイルが通らない)。そして、コンパイルは通るけど、なぜかVS Codeエディタのプレビューができないです。
#//imgtable[sample][サンプル]{
//}

強制改行

このあと改行@<br>{}

改行した後、字下げしたくない場合は、noindenを組み合わせます。

//noindent
字下げしたくない文字

何も文字がないところで以下のように強制改行だけ使うとコンパイルエラーになるので気をつけましょう(ハマりました)。

@<br>{}

表紙

  • デフォルトのB5サイズ(18.2cmx25.7cm)だと、Keynoteだと516ptx728ptで作成するとちょうどになります

  • デザインは、技術書典とか技術同人博覧会のよいものを参考にしました。

作例

なかなか

まとめ

Re:VIEW執筆、最初は環境構築含め大変でしたが、商業出版に耐えれるレベルの出力ができるのは良いですね。同じコンテンツから、紙、電子媒体とさまざまなプラットフォームのフォーマットに対応できる点も素晴らしいです。

今回は、最初はGoogle Documentで書いて、途中からRe:VIEWで書き直したので大変でしたが、最初からRe:VIEWで書けば効率よくそこまで手間ではないかもですね。

参考リンク

参考にした情報です。

ガイド的なもの

チートシート

フォーマットガイド

ユーザーズガイド(PDF)

Tips的なもの

https://blog.ch3cooh.jp/entry/review

https://www.docswell.com/s/juraruming/5D4WVK-2022-07-25-172543

https://zenn.dev/sikkim/articles/d5e6d851d100d2

https://review-knowledge-ja.readthedocs.io/ja/latest/latex/modify-abit.html

書籍

https://amzn.to/45h0R5q

https://amzn.to/3BLK4cR

関連記事

https://karaage.hatenadiary.jp/entry/2021/08/04/073000

https://zenn.dev/karaage0703/books/80b6999d429abc8051bb

Discussion