Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

review-textmakerについてquickstartに記述 #944

Merged
merged 1 commit into from
Feb 12, 2018
Merged

review-textmakerについてquickstartに記述 #944

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions doc/quickstart.ja.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,24 +113,28 @@ review-init コマンドによらず、独自に作業フォルダを作成し

テキストファイルの文字エンコーディングには、UTF-8 を使用してください。

### PDF 化と EPUB 化
### PDF 化と EPUB 化、プレインテキスト化

review-pdfmaker コマンドで PDF ブックの作成、review-epubmaker コマンドで EPUB ファイルの作成ができます。
review-pdfmaker コマンドで PDF ブックの作成、review-epubmaker コマンドで EPUB ファイルの作成、review-textmaker コマンドでプレインテキストの作成ができます。

PDF を作成するには、TeXLive2012 以上の環境が必要です。EPUB を作成するには、rubyzip gem あるいは zip コマンドが必要です（MathML も使いたいときには、 [MathML ライブラリ](http://www.hinet.mydns.jp/?mathml.rb)も必要です）。

いずれのコマンドも、必要な設定情報を記した YAML 形式ファイルを引数に指定して実行します。review-init コマンドで作成した環境には、デフォルトで config.yml として用意されているので、これを利用します。

```bash
$ review-pdfmaker config.yml ←PDFの作成
$ review-epubmaker config.yml ←EPUBの作成
$ review-pdfmaker config.yml ←PDFの作成
$ review-epubmaker config.yml ←EPUBの作成
$ review-textmaker config.yml ←テキストの作成（装飾情報あり）
$ review-textmaker -n config.yml ←テキストの作成（装飾情報なし）
```

rake コマンドを利用できるなら、次のように実行することもできます。

```bash
$ rake pdf ←PDFの作成
$ rake epub ←EPUBの作成
$ rake text ←テキストの作成（装飾情報あり）
$ rake plaintext ←テキストの作成（装飾情報なし）
```

config.yml のサンプルについては以下を参照してください。
Expand Down
19 changes: 11 additions & 8 deletions doc/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,28 +115,31 @@ The web site of Re:VIEW is @<tt>{https://reviewml.org/}.

You should use UTF-8 as encodings in text files.

### generating PDF and EPUB
### generating PDF, EPUB, and plain-text

You can generate a PDF file with `review-pdfmaker` command. Also you can generate an EPUB file with `review-epubmaker` command.
You can generate a PDF file with `review-pdfmaker` command. Also you can generate an EPUB file with `review-epubmaker` command, and can generate an plain-text file with 'review-textmaker' command.

To generate PDF, you should install TeXLive 2012 or later. To generate EPUB, you should install zip command.
When you want to use MathML, you should install [MathML library](http://www.hinet.mydns.jp/?mathml.rb)

`review-pdfmaker` and `review-epubmaker` need `config.yml`, configuration YAML files. `review-init` command generates `config.yml` in default.
Each maker need `config.yml`, configuration YAML files. `review-init` command generates `config.yml` in default.

```bash
$ review-pdfmaker config.yml ## generate PDF
$ review-epubmaker config.yml ## generate EPUB
$ review-pdfmaker config.yml ## generate PDF
$ review-epubmaker config.yml ## generate EPUB
$ review-textmaker config.yml ## generate text with decoration
$ review-textmaker -n config.yml ## generate text without decoration
```

You also can generate them with Rake.

```bash
$ rake pdf ## generate PDF
$ rake epub ## generate EPUB
$ rake pdf ## generate PDF
$ rake epub ## generate EPUB
$ rake text ## generate text with decoration
$ rake plaintext ## generate text without decoration
```


There is a sample YAML file [config.yml.sample](https://github.com/kmuto/review/blob/master/doc/config.yml.sample) in the same directory of this document.

### add chapters and modify them
Expand Down