= インストール //abstract{ Re:VIEW Starterを使っていただき、ありがとうございます。 この章では、Re:VIEW Starterを使うために必要となる「Ruby」と「TeXLive」のインストール方法を説明します。 //} #@#//makechaptitlepage[toc=on] == RubyとTeXLiveのインストール Re:VIEW StarterでPDFを生成するには、RubyとTeXLiveのインストールが必要です。 * Rubyとは世界中で人気のあるプログラミング言語のことです。 原稿ファイル(「@{*.re}」ファイル)を読み込むのに必要です。 * TeXLiveとは有名な組版ソフトのひとつです。 PDFファイルを生成するのに必要です。 これらのインストール手順を説明します。 === Dockerの使い方を知っている場合 Dockerとは、簡単に言えば「WindowsやMacでLinuxコマンドを実行するためのソフトウェア」です@{guoes}。 //footnote[guoes][Dockerについてのこの説明は、技術的にはちっとも正確ではありません。しかしITエンジニア以外に説明するには、このような説明で充分です。] Dockerの使い方が分かる人は、@{https://hub.docker.com/r/kauplan/review2.5/, kauplan/review2.5}のDockerイメージを使ってください。 これでRubyとTeXLiveの両方が使えるようになります。 //terminal[][Dockerイメージのダウンロードと動作確認]{ $ @{docker pull kauplan/review2.5} @{3GB 以上ダウンロードするので注意} $ @{docker run --rm kauplan/review2.5 ruby --version} ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-linux-gnu] $ @{docker run --rm kauplan/review2.5 uplatex --version} e-upTeX 3.14159265-p3.7.1-u1.22-161114-2.6 (utf8.uptex) (TeX Live 2017/Debian) ...(省略)... //} === macOSを使っている場合 macOSにおいて、RubyとTeXLiveをインストールする方法を説明します。 ==== Rubyのインストール macOSには最初からRubyがインストールされているため、Rubyを別途インストールする必要はありません。 Rubyがインストールされていることを確認するために、Terminal.app@{zp54n}を起動して以下のコマンドを入力してみましょう。 なお各行の先頭にある「@{$ }」は入力せず、下線がついている部分のコマンドを入力してください。 //footnote[zp54n][Terminal.appは、ファインダで「アプリケーション」フォルダ > 「ユーティリティ」フォルダ > 「ターミナル」をダブルクリックすると起動できます。] //terminal[][Rubyがインストールされていることを確認]{ $ @{which ruby} @{下線が引かれたコマンドだけを入力すること} /usr/bin/ruby @{このような表示になるはず} $ @{ruby --version} @{下線が引かれたコマンドだけを入力すること} ruby 2.3.7p456 (2018-03-28 revision 63024) [universal.x86_64-darwin18] //} 実際の出力結果は上と少し違うはずですが、だいたい合っていればOKです。 また、必要なライブラリをインストールするために、以下のコマンドも実行してください(各行の先頭にある「@{$ }」は入力せず、それ以降のコマンドを入力してください)。 //terminal[][必要なライブラリをインストール]{ $ @{gem install review --version=2.5} $ @{review version} 2.5.0 @{必ず「2.5.0」であること(より新しいバージョンは未サポート)} //} ==== MacTeXのインストール 次に、MacTeXをダウンロードします。MacTeXとは、macOS用のTeXLiveです。 MacTeXはサイズが大きい(約4GB)ので、本家ではなく以下のミラーサイトのどれかを使ってください。 * @{http://ftp.jaist.ac.jp/pub/CTAN/systems/mac/mactex/}@
{} > @{mactex-20200407.pkg} * @{http://ftp.kddilabs.jp/pub/ctan/systems/mac/mactex/}@
{} > @{mactex-20200407.pkg} * @{http://ftp.riken.go.jp/pub/CTAN/systems/mac/mactex/}@
{} > @{mactex-20200407.pkg} ダウンロードができたら、ダブルクリックしてインストールしてください。 インストールしたら、Terminal.appで次のコマンドを入力し、動作を確認してください(各行の先頭にある「@{$ }」は入力せず、それ以降のコマンドを入力してください)。 //terminal[][MacTeXのインストールができたことを確認]{ $ @{which uplatex} @{下線が引かれたコマンドだけを入力すること} /Library/TeX/texbin/uplatex $ @{uplatex --version} @{下線が引かれたコマンドだけを入力すること} e-upTeX 3.14159265-p3.8.1-u1.23-180226-2.6 (utf8.uptex) (TeX Live 2020) ...(省略)... //} 実際の出力結果は上と少し違うはずですが、だいたい合っていればOKです。 最後に、MacTeXでヒラギノフォントを使うための準備が必要です(これをしないと、PDFファイルの日本語フォントが見るに耐えません)。 そのためには、以下のページから「Bibunsho7-patch-1.5-20200511.dmg」@{873gn}をダウンロードしてください。 //footnote[873gn][日付が最新のものを選んでください。2020年6月時点では「20200511」が最新です。] * @{https://github.com/munepi/bibunsho7-patch/releases} ダウンロードしたらダブルクリックして解凍し、「Patch.app」をダブルクリックしてください。 === Windowsを使っている場合 Windowsにおいて、RubyとTeXLiveをインストールする方法を説明します。 ==== Rubyのインストール 以下のページにアクセスし、「Ruby+Devkit 2.6.6-1 (x64)」をダウンロードしてインストールしてください。 * @{https://rubyinstaller.org/downloads/} インストールしたら、コマンドプロンプトで以下のコマンドを入力し、Rubyが実行できることを確かめてください。 //terminal[][Rubyが実行できることを確認]{ C:\Users\yourname> @{ruby --version} @{「ruby --version」だけを入力} ruby 2.6.6-1 [x64-mingw32] //} 実際の出力結果は上と少し違うと思いますが、だいたい合っていればOKです。 また以下のコマンドを実行し、必要なライブラリをインストールします。 //terminal[][必要なライブラリをインストール]{ C:\Users\yourname> @{gem install review --version=2.5} C:\Users\yourname> @{review version} 2.5.0 @{必ず「2.5.0」であること(より新しいバージョンは未サポート)} //} ==== TeXLiveのインストール 次に、Windows用のTeXLiveをインストールします。詳しくはこちらのページを参照してください。 このうち、手順(16)において右上の「すべて」ボタンを押してください(つまりすべてのパッケージを選ぶ)。 * 「TeXLive2020をインストールしてLaTeXを始める」 @
{}@{https://tm23forest.com/contents/texlive2020-install-latex-begin} インストールできたら、コマンドプロンプトで以下のコマンドを実行してみてください。 //terminal[][コマンドが実行できることを確認]{ C:\Users\yourname> @{uplatex --version} @{「uplatex --version」だけを入力} e-upTeX 3.14159265-p3.7.1-u1.22-161114-2.6 (utf8.uptex) (TeX Live 2020/W32TeX) ...(以下省略)... //} 実際の出力結果は上と少し違うと思いますが、だいたい合っていればOKです。 == プロジェクトを作成 RubyとTeXLiveをインストールしたら、次に本を作るための「プロジェクト」を作成しましょう。 以下のWebサイトにアクセスしてください。 * @{https://kauplan.org/reviewstarter/} アクセスしたら、画面の指示に従って操作をしてください(詳細は省略します)。 するとプロジェクトが作成されて、zipファイルがダウンロードできます。 以降では、プロジェクトのzipファイル名が「@{mybook.zip}」だったとして説明します。 =={sec-generatesample} サンプルのPDFファイルを生成 プロジェクトのzipファイルをダウンロードしたら、解凍してサンプルのPDFファイルを生成してみましょう。 ==={subsec-indocker} Dockerの場合 Dockerを使う場合は、次のような手順でサンプルのPDFファイルを生成してみましょう。 //terminal[][Dockerを使ってPDFファイルを生成する]{ $ @{unzip mybook.zip} @{zipファイルを解凍} $ @{cd mybook/} @{ディレクトリを移動} $ @{docker run --rm -v $PWD:/work -w /work kauplan/review2.5 rake pdf} $ @{ls *.pdf} @{PDFファイルが生成できたことを確認} mybook.pdf //} これでPDFファイルが生成されるはずです。生成できなかった場合は、Twitterで「@{#reviewstarter}」タグをつけて質問してください(相手先不要)。 Dockerを使ってPDFファイルが作成できることを確認したら、このあとはdockerコマンドを使わずとも「@{rake docker:pdf}」だけでPDFファイルが生成できます。 //terminal[][より簡単にPDFファイルを生成する]{ $ @{docker run --rm -v $PWD:/work -w /work kauplan/review2.5 rake pdf} $ @{@{rake docker:pdf}} @{これだけでPDFファイルが生成される} //} //note[もっと簡単にPDFファイルを生成するためのTips]{ 環境変数「@{$RAKE_DEFAULT}」を設定すると、引数なしの「@{rake}」コマンドだけでPDFファイルが生成できます。 //terminal[][環境変数「@{$RAKE_DEFAULT}」を設定する]{ $ @{export RAKE_DEFAULT="docker:pdf"} @{環境変数を設定} $ @{rake docker:pdf} $ @{rake} @{「rake docker:pdf」が実行される} //} またシェルのエイリアス機能を使うと、コマンドを短縮名で呼び出せます。 //terminal[][シェルのエイリアス機能を使う]{ $ @{alias pdf="rake docker:pdf"} @{エイリアスを設定} $ @{pdf} @{「rake docker:pdf」が実行される} //} //} === macOSの場合 macOSを使っている場合は、Terminal.app@{qqyo5}を開いて以下のコマンドを実行してください。 ここで、各行の先頭にある「@{$ }」は入力せず、それ以降のコマンドを入力してください。 //footnote[qqyo5][繰り返しになりますが、Terminal.appはファインダで「アプリケーション」フォルダ > 「ユーティリティ」フォルダ > 「ターミナル」をダブルクリックすると起動できます。] //terminal[][PDFファイルを生成する]{ $ @{unzip mybook.zip} @{zipファイルを解凍し、} $ @{cd mybook/} @{ディレクトリを移動} $ @{rake pdf} @{PDFファイルを生成} $ @{ls *.pdf} @{PDFファイルが生成されたことを確認} mybook.pdf $ @{open mybook.pdf} @{PDFファイルを開く} //} これでPDFファイルが生成されるはずです。生成できなかった場合は、Twitterで「@{#reviewstarter}」タグをつけて質問してください(相手先不要)。 //note[もっと簡単にPDFファイルを生成するためのTips]{ 環境変数「@{$RAKE_DEFAULT}」を設定すると、引数なしの「@{rake}」コマンドだけでPDFファイルが生成できます。 //terminal[][環境変数「@{$RAKE_DEFAULT}」を設定する]{ $ @{export RAKE_DEFAULT="pdf"} @{環境変数を設定} $ @{rake pdf} $ @{rake} @{「rake pdf」が実行される} //} またシェルのエイリアス機能を使うと、コマンドを短縮名で呼び出せます。 //terminal[][シェルのエイリアス機能を使う]{ $ @{alias pdf="rake pdf"} @{エイリアスを設定} $ @{pdf} @{「rake pdf」が実行される} //} //} === Windowsの場合 Windowsを使っている場合は、まずプロジェクトのzipファイル(@{mybook.zip})をダブルクリックして解凍してください。 そしてコマンドプロンプトで以下のコマンドを実行してください。 //terminal[][PDFファイルを生成する]{ C:\Users\yourname> @{cd mybook} @{解凍してできたフォルダに移動} C:\Users\yourname\mybook> @{rake pdf} @{PDFファイルを生成} C:\Users\yourname\mybook> @{dir *.pdf} @{PDFファイルが生成されたことを確認} //} これでPDFファイルが生成されるはずです。生成できなかった場合は、Twitterで「@{#reviewstarter}」タグをつけて質問してください(相手先不要)。 == 注意点 注意点をいくつか説明します。 * エラーが発生したときの対処法は@{02-tutorial|subsec-compileerror}で簡単に説明しています。 必ず読んでください。 * ePubファイルを生成するときは「@{rake epub}」または「@{rake docker:epub}」、HTMLファイルを生成するときは「@{rake web}」または「@{rake docker:epub}」を実行してください。 * Starterでは「@{review-pdfmaker}」コマンドや「@{review-epubmaker}」コマンドが使えません(実行はできますが望ましい結果にはなりません)。 必ず「@{rake pdf}」や「@{rake epub}」を使ってください。