Skip to content
Re:VIEW is flexible document format/conversion system
Ruby TeX HTML JavaScript Dockerfile
Branch: master
Clone or download

Latest commit

kmuto Merge pull request #1501 from kmuto/webmaker-math
webmaker,textmakerが数式画像を作り忘れているのを修正
Latest commit 18646ff Apr 20, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows GitHub Actions: use `ruby/setup-ruby` instead of `eregon/use-ruby-act… Mar 25, 2020
bin revert name: rename from review-toc to review-index Mar 16, 2020
debian Use https: instead of git: May 1, 2017
doc revert name: rename from review-toc to review-index Mar 16, 2020
lib forgotten on textmaker also. Apr 20, 2020
samples calculate more acculate page volume using unicode/eaw (when it exists) Mar 15, 2020
templates update test. expectation is correct. implementation has a bug around … Mar 14, 2020
test count codelist and text for calculating page volume. Mar 15, 2020
vendor copy jsclasses 2020/02/02 version (b02363c4c5b41faf9b2bb44ef2d74601a9… Feb 19, 2020
.gitignore ignore tmp files of editors Dec 26, 2016
.rubocop.yml avoid duplication of creating same math. Closes: #1488 Mar 25, 2020
.rubocop_todo.yml
.travis.yml do not update rubygems Aug 25, 2019
COPYING import from latest SVN Jan 16, 2010
Dockerfile add git-core and tls set Nov 3, 2019
Gemfile refactoring codes by rubocop suggestions Sep 23, 2017
NEWS.ja.md #1484 Feb 25, 2020
NEWS.md #1484 Feb 25, 2020
README.md happy new year Jan 1, 2020
Rakefile use simplecov instead of rcov Mar 24, 2018
appveyor.yml add new actions for windows (#1460) Jan 1, 2020
review.gemspec fix date Feb 19, 2020

README.md

Re:VIEW

Gem Version Build Status Build status

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

Supported Formats

supported formats

Output formats Re:VIEW supports are:

  • EPUB
  • LaTeX
  • InDesign (IDGXML)
  • Markdown
  • plain text (TOPBuilder Text Markup Language)

Re:VIEW uses its original format('Re:VIEW format') as source files. See doc/format.md.

Commands

There are commands generate files directly.

  • review-epubmaker: generate EPUB file.
  • review-pdfmaker: generate PDF file using LaTeX (TeXLive).
  • review-textmaker: generate text files.
  • review-webmaker: generate Web pages.
  • review-idgxmlmaker: generate InDesign XML files.

And some useful commands.

  • review-init: create a project.
  • review-compile: compile Re:VIEW format files.
  • review-vol: figure out size of Re:VIEW files.
  • review-index: generate index with various format.
  • review-preproc: preprocessor.
  • review-epub2html: generate single HTML file from EPUB for CSS typesetting.
  • review-update: update project files.

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

Quick Start

$ review-init hello
$ cd hello
$ (... add and edit *.re file, config.yml and catalog.yml ...)
$ rake epub    ## generating EPUB
$ rake pdf     ## generating PDF (Requirement TeXLive)
$ rake text    ## generating texts
$ rake web     ## generating Web pages
$ rake idgxml  ## generating InDesign XML files

For further information, see doc/quickstart.md

Resources

URL
Home http://reviewml.org
Project https://github.com/kmuto/review/
Gems https://rubygems.org/gems/review
Wiki https://github.com/kmuto/review/wiki
Bugs https://github.com/kmuto/review/issues

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

Main part of Re:VIEW is applied GNU Lesser General Public License (LGPL). See COPYING file.

Exception:

  • doc/, samples/: MIT License. See LICENSE file.
  • jumoline.sty, vendor/jumoline: The LaTeX Project Public License. See LPPL file.
  • plistings.sty, vendor/plistings: MIT License. See LICENSE file.
  • gentombow.sty, vendor/gentombow: BSD License. See LICENSE file.
  • jsbook.cls, vendor/jsclasses: BSD License. See LICENSE file.

Copyright

Copyright (c) 2006-2020 Minero Aoki, Kenshi Muto, Masayoshi Takahashi, Masanori Kado.

You can’t perform that action at this time.