Re:VIEW

<img src=“https://secure.travis-ci.org/kmuto/review.png”/> <img src=“https://badge.fury.io/rb/review.png” alt=“Gem Version” />

home

github.com/kmuto/review

gems

rubygems.org/gems/review

wiki

github.com/kmuto/review/wiki

bugs

github.com/kmuto/review/issues

Re:VIEW is an easy-to-use digital publishing system for books and ebooks.

Format

Re:VIEW uses its original format(‘Re:VIEW format’) as source files. See doc/format.rdoc (in Japanese).

Output formats Re:VIEW supports are:

  • EPUB

  • LaTeX(ptexlive)

  • InDesign(IDGXML)

  • plain text(TOPBuilder Text Markup Language)

  • Inao(gihyo.jp original markup)

Commands

There are two commands generate files directly.

  • review-epubmaker: generate EPUB file.

  • review-pdfmaker: generate PDF file using LaTeX(ptexlive).

And some useful commands.

  • review-compile: compile Re:VIEW fomat files.

  • review-vol: figure out size of Re:VIEW files.

  • review-index: generate index with various format.

  • review-preproc: preprocessor.

Installation

Install gem yourself as:

$ gem install review

Or build from source:

$ git clone https://github.com/kmuto/review.git
$ cd review
$ rake install

Or add the ‘./bin` directory to your $PATH:

$ echo "export PATH=PATH_OF_REVIEW/bin:$PATH" >> ~/.profile

Resources

Documents

Issues tracker

Note on Patches/Pull Requests

  • Fork the project.

  • Make your feature addition or bug fix.

  • Add tests for it. This is important so I don’t break it in a future version unintentionally.

  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)

  • Send me a pull request. Bonus points for topic branches.

License

LGPL. See COPYING file.

Copyright © 2006-2015 Minero Aoki, Kenshi Muto, Masayoshi Takahashi, Masanori Kado.