- 【従来の方法】
-
- プロジェクトを作成してから、設定ファイルを編集
- 手間と時間がかかる、特に LaTeX 関連を調べるのは難易度が高い
- 【Re:VIEW Starter】
-
- 画面で設定してから、プロジェクトを作成
- LaTeX の知識が必要なく、初心者でも簡単
Re:VIEW Starter
Re:VIEW の初期設定が画面でできる！
Re:VIEW Starter へようこそ。
このサイトを使うと、Re:VIEW の面倒な初期設定を GUI で行ってから、プロジェクトを開始できます。
自分で調べたりカスタマイズする手間と時間を大きく削減できるので、初めて Re:VIEW を使う人に最適です。
なお、現在のところ Re:VIEW 2.5 のみをサポートしています。
Re:VIEW 3.0 や 4.0 はサポートしていません（2.x との互換性がないため）。ご注意ください。
Re:VIEW Starter の特徴は Qiita での紹介記事を、詳細と出力例は『ユーザーズガイド』を、最近の変更点はChangeLogを見てください。
また、ご意見・ご感想は「#reviewstarter」というタグでツイートしてください。
まずは著者名（or サークル名）を教えてください。
省略した場合、こちらで勝手に埋めますのでご注意を。
（補足：あとから変更する場合は config.yml の「aut:」を編集してください。）
同人誌のタイトルを決めてください。
サブタイトルがあればそれも教えてください。
タイトルが長い場合は、希望する箇所で改行してください。
（補足：あとから変更する場合は config.yml の「title:」を編集してください。）
同人誌のサイズを決めましょう。
一般的には、同人誌では「B5」と「A5」が使われます。
- レポートや論文とは違い、「A4」は使われません。
- 小説同人誌では「B6」やより小さいサイズが使われますが、これは縦書きが前提です。
横書きを使う技術書では幅が狭すぎます。
（補足：あとから変更するには config-starter.yml の「pagesize:」を変更します。）
フォントの大きさと、一行あたりの文字数を決めましょう。
- フォントの大きさは、B5なら「10pt」、A5なら「9pt」がお勧め。
8ptは小さすぎて読みにくいので、お勧めしません。 - 初心者向け入門書では、フォントサイズを少し大きくしましょう。
B5なら「11pt」、A5なら「10pt」にすると、紙面から受ける圧迫感が減ります。
ページ左右の余白幅は自動的に設定されます。
（補足：フォントサイズも1行あたり文字数も、config-starter.yml で変更できます。）
章タイトルや目次を右ページから始めるかどうか、決めましょう。
一般的な本では、章や目次を見開きの右ページから始めます（横書きの場合）。
これを「右起こし（右ページ起こし）」や「片起こし」といいます。
ただしページ数が少ない場合や見開きをしない電子書籍用 PDF なら、採用しなくていいでしょう。
- （主に紙の本向け、詳しい説明） （詳細：config.yml の「texdocumentclass:」に「openright」をつける）
- （主に電子書籍用 PDF 向け、詳しい説明） （詳細：config.yml の「texdocumentclass:」に「openany」をつける）
- （少ページ数の紙の本向け、詳しい説明） （詳細：config.yml の「texdocumentclass:」に「openright」をつけ、かつ sty/starter-toc.sty で \tableofcontents を上書き）
章 (Chapter) や節 (Section) や項 (Subsection) のタイトルデザインを決めてください。
ラジオボタンをクリックすると、プレビューに反映されます。
第1章
章タイトルサンプル
1.1 節タイトルサンプル
♣ 1.1.1 項タイトルサンプル
本文サンプル、本文サンプル、本文サンプル、本文サンプル、本文サンプル、本文サンプル、本文サンプル、本文サンプル、本文サンプル。
（補足：章や節のデザインを調整するには、config-starter.yml の設定を変更するか、
あるいは sty/starter-heading.sty の該当箇所を編集してください。
また項に番号をつけるには、config.ymlの「secnolevel:」に「3」を設定してください。）
等幅フォントを選んでください。選ぶとプレビューが表示されます。
（注：フォントのオプションはプログラム用とターミナル用で共通です。
そのため一方のチェックボックスを選択するともう一方も選択状態になります。）
プログラム用等幅フォント
-
（LaTeXのデフォルト。1とl、0とOが見分けにくい。太字が目立たない。）
- （文字が細いので太字が目立つ。1とl、0とOが見分けにくい。文字幅が広い。）
- （1とl、0とOが見分けやすい。「'」と「`」が見分けにくい。）
-
（1とl、0とOが見分けやすい。文字幅が少し狭い。）
ターミナル用等幅フォント
-
（LaTeXのデフォルト。1とl、0とOが見分けにくい。太字が目立たない。）
- （文字が細いので太字が目立つ。1とl、0とOが見分けにくい。文字幅が広い。）
- （1とl、0とOが見分けやすい。「'」と「`」が見分けにくい。）
-
（1とl、0とOが見分けやすい。文字幅が少し狭い。）
プログラムやターミナルの表示オプションを選んでください。
- （本文 10pt なら 9pt に、本文 9pt なら 8pt に） （詳細：config-starter.yml で「program_fontsize: small」を設定する）
- （本文 10pt なら 9pt に、本文 9pt なら 8pt に） （詳細：config-starter.yml で「terminal_fontsize: small」を設定する）
- （同上） （詳細：config-starter.yml で「caption_small: true」を設定する）
- （表示サンプル） （詳細：config-starter.yml で「caption_pretty: true」を設定する）
- （表示サンプル） （詳細：config-starter.yml で「program_border: true」を設定する）
- （実験的機能） （詳細：config-starter.yml に「inlinecode_gray: true」をつける）
その他のオプションを選んでください。
- （中身がカラーになる） （詳細：config-starter.yml に「target: ebook」をつける）
- （詳細：config.yml に「toc: true」をつける）
- （詳細：config.yml に「titlepage: true」をつける）
- （詳細：config.yml に「colophon: true」をつける）
- （詳細：config-starter.yml で「colophon_poweredby: true」を設定する）
- （生成した中間LaTeXファイルを削除しない） （詳細：config.yml に「debug: true」をつける）
- （表示サンプル） （詳細：sty/starter.sty で \reviewimage 環境を上書きする）
- （ファイル数が多いときは強くオススメ） （詳細：config.yml に「contentdir: contents」をつける）
最後に、プロジェクト名や印刷所や出版予定日やイベント名を指定してください。
プロジェクト名は、アルファベットと数字と「-」と「_」のみ。
印刷所は、未定ならダミーの印刷所名を使い、あとから config.yml を変更してください。
出版予定日とイベント名は、タイトルページ（大扉）の下部に表示されます。
（補足：あとから変更する場合は、config.yml の「bookname:」や「prt:」や「date:」や「pubevent_name:」を編集してください。）
これで準備ができました。
以下のボタンをクリックしてファイルをダウンロードしてください。
（注：ダウンロードしたファイルは Re:VIEW 2.5 で動作します。
Re:VIEW 3.0 では動作しません（2.x と互換性がないため）。不具合があればご一報を。）
ダウンロードしたら、コンパイルしましょう。ターミナルで次のように実行してください。
### Docker を使う場合 $ unzip mybook.zip $ cd mybook/ $ docker pull kauplan/review2.5 ← 3GB 以上ダウンロードするので注意 $ docker run --rm -v $PWD:/work -w /work kauplan/review2.5 rake pdf ↑ macOS ならこれ (docker run ....) のかわりに rake docker:pdf でもOK $ ls mybook.pdf ### Docker を使わない場合 (Ruby と Re:VIEW と LaTeX が必要) $ unzip mybook.zip $ cd mybook/ $ rake setup:rubygems ← または gem install review --version=2.5 $ rake pdf $ ls mybook.pdf
【注意】
-
Dockerイメージは「kauplan/review2.5」を使ってください。
「vvakame/review」だと LaTeX のフォントやスタイルファイルが足りず、コンパイルエラーになります。 - 詳しい使い方はユーザーズガイドを、最近の変更点はChangeLogを、困ったときは#reviewstarterタグでツイートしてください。
Enjoy!