review-retrovert 0.9.11 → 0.10.0

data/testdata/mybook/contents/00-preface.re

@@ -1,129 +0,0 @@
-= まえがき / はじめに
-
-//centering{
-＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊ @<strong>{注意} ＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊
-//}
-
-このドキュメントは、Re:VIEWのサンプル原稿を兼ねています。
-自分の原稿を書くときは、サンプルの原稿ファイルと画像ファイルを消してください。
-
-
-//cmd[サンプルファイル（原稿と画像）の消し方（コマンドラインを知らない人はごめん！）]{
-$ @<userinput>{ls contents/}            @<balloon>{原稿ファイルの一覧}
-00-preface.re		03-syntax.re		06-bestpractice.re
-01-install.re		04-customize.re		92-filelist.re
-02-tutorial.re		05-faq.re		99-postface.re
-$ @<userinput>{rm contents/*.re}        @<balloon>{原稿のファイルを消す}
-$ @<userinput>{rm -r images/*}          @<balloon>{画像ファイル（が入ったディレクトリ）も消す}
-$ @<userinput>{vi catalog.yml}          @<balloon>{各章のファイル名を変更する}
-//}
-
-本文での、1行あたりの文字数の確認：
-
-//noindent
-一二三四五六七八九十一二三四五六七八九十一二三四五六七八九十一二三四五六七八九十一二三四五六七八九十一二三四五六七八九十
-
-//list[][プログラムリストでの、1行あたりの文字数の確認（font: beramono）]{
-123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_
-一二三四五六七八九十一二三四五六七八九十一二三四五六七八九十一二三四五六七八九十一二三四五六七八九十
-//}
-
-//terminal[][ターミナルでの、1行あたりの文字数の確認（font: inconsolata）]{
-123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_
-一二三四五六七八九十一二三四五六七八九十一二三四五六七八九十一二三四五六七八九十一二三四五六七八九十
-//}
-
-
-//centering{
-＊＊＊＊＊＊＊＊＊＊＊ 以下、まえがきのサンプル ＊＊＊＊＊＊＊＊＊＊＊@<br>{}
-//}
-
-
-本書を手に取っていただき、ありがとうございます。
-
-本書は、XXXについてわかりやすく解説した本です。
-この本を読めば、XXXの基本が身につきます。
-
-
-====[notoc] 本書の目的
-
-本書の目的は、XXXの基礎的な使い方を身につけることです。
-具体的には、XXXを使ってXXXやXXXやXXXができるようになることです。
-
-ただし、XXXやXXXといった内容は、本書では扱いません。
-
-
-====[notoc] 本書の対象読者
-
-本書では次のような人を対象としています。
-
- * XXXについて興味がある人
- * XXXの入門書を読んだ初級者の人（まったくの初心者は対象外です）
-
-
-====[notoc] 前提とする知識
-
-本書を読むにあたり、次のような知識が必要となります。
-
- * Linuxについての基礎知識
- * 何らかのプログラミング言語の基礎知識
-
-
-====[notoc] 問い合わせ先
-
-本書に関する質問やお問い合わせは、次のページまでお願いします。
-正誤表とサンプルコードもここにあります。
-
- * URL: @<href>{https://www.example.com/mybook/}
-
-
-====[notoc] 謝辞
-
-本書はXXXX氏とXXXX氏にレビューしていただきました。
-この場を借りて感謝します。ありがとうございました。
-
-
-
-//clearpage
-
-==[notoc] 凡例
-
-本書では、プログラムコードを次のように表示します。太字は強調を表します。
-
-//list[][]{
-print("Hello, @<b>|world|!\n");       @<balloon>{太字は強調}
-//}
-
-プログラムコードの差分を表示する場合は、追加されたコードを太字で、削除されたコードを取り消し線で表します。
-
-//list[][]{
-@<del>|print("Hello, @<b>|world|!\n");|       @<balloon>{取り消し線は削除したコード}
-@<b>|print("Hello, "+name+"!\n");|    @<balloon>{太字は追加したコード}
-//}
-
-長い行が右端で折り返されると、折り返されたことを表す小さな記号がつきます。
-
-//list[][]{
-123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_
-//}
-
-ターミナル画面は、次のように表示します。
-行頭の「@<code>|$ |」はプロンプトを表し、ユーザが入力するコマンドには薄い下線を引いています。
-
-//terminal{
-$ @<userinput>|echo Hello|       @<balloon>{行頭の「$ 」はプロンプト、それ以降がユーザ入力}
-//}
-
-本文に対する補足情報や注意・警告は、次のようなノートや囲み枠で表示します。
-
-//note[ノートタイトル]{
-ノートは本文に対する補足情報です。
-//}
-
-//info[タイトル]{
-本文に対する補足情報です。
-//}
-
-//caution[タイトル]{
-本文に対する注意・警告です。
-//}

data/testdata/mybook/contents/01-install.re

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