<!DOCTYPE html>
<html> <head> <meta content=“text/html; charset=UTF-8” http-equiv=“Content-Type”>
<title>README - review-1.7.2 Documentation</title>
<link type=“text/css” media=“screen” href=“./rdoc.css” rel=“stylesheet”>
<script type=“text/javascript”>
var rdoc_rel_prefix = "./";
</script>
<script type=“text/javascript” charset=“utf-8” src=“./js/jquery.js”></script> <script type=“text/javascript” charset=“utf-8” src=“./js/navigation.js”></script> <script type=“text/javascript” charset=“utf-8” src=“./js/search_index.js”></script> <script type=“text/javascript” charset=“utf-8” src=“./js/search.js”></script> <script type=“text/javascript” charset=“utf-8” src=“./js/searcher.js”></script> <script type=“text/javascript” charset=“utf-8” src=“./js/darkfish.js”></script>
<body class=“file”> <nav id=“metadata”>
<nav id="home-section" class="section"> <h3 class="section-header"> <a href="./index.html">Home</a> <a href="./table_of_contents.html#classes">Classes</a> <a href="./table_of_contents.html#methods">Methods</a> </h3>
</nav>
<nav id="search-section" class="section project-section" class="initially-hidden"> <form action="#" method="get" accept-charset="utf-8"> <h3 class="section-header"> <input type="text" name="search" placeholder="Search" id="search-field" title="Type to search, Up and Down to navigate, Enter to load"> </h3> </form> <ul id="search-results" class="initially-hidden"></ul>
</nav>
<div id=“table-of-contents”>
<nav class="section"> <h3 class="section-header">Table of Contents</h3> <ul> <li><a href="#label-Re%3AVIEW">Re:VIEW</a> <li><a href="#label-Format">Format</a> <li><a href="#label-Commands">Commands</a> <li><a href="#label-Installation">Installation</a> <li><a href="#label-Resources">Resources</a> <li><a href="#label-Documents">Documents</a> <li><a href="#label-Issues+tracker">Issues tracker</a> <li><a href="#label-Note+on+Patches%2FPull+Requests">Note on Patches/Pull Requests</a> <li><a href="#label-License">License</a> <li><a href="#label-Copyright">Copyright</a> </ul> </nav>
</div>
<div id="project-metadata"> <nav id="fileindex-section" class="section project-section"> <h3 class="section-header">Pages</h3> <ul> <li class="file"><a href="./ChangeLog.html">ChangeLog</a> <li class="file"><a href="./README_rdoc.html">README</a> </ul>
</nav>
<nav id="classindex-section" class="section project-section"> <h3 class="section-header">Class and Module Index</h3> <ul class="link-list"> <li><a href="./EPUBMaker.html">EPUBMaker</a> <li><a href="./EPUBMaker/Content.html">EPUBMaker::Content</a> <li><a href="./EPUBMaker/EPUBCommon.html">EPUBMaker::EPUBCommon</a> <li><a href="./EPUBMaker/EPUBv2.html">EPUBMaker::EPUBv2</a> <li><a href="./EPUBMaker/EPUBv3.html">EPUBMaker::EPUBv3</a> <li><a href="./EPUBMaker/Producer.html">EPUBMaker::Producer</a> <li><a href="./HTMLLayout.html">HTMLLayout</a> <li><a href="./LineInput.html">LineInput</a> <li><a href="./Object.html">Object</a> <li><a href="./ReVIEW.html">ReVIEW</a> <li><a href="./ReVIEW/ApplicationError.html">ReVIEW::ApplicationError</a> <li><a href="./ReVIEW/Book.html">ReVIEW::Book</a> <li><a href="./ReVIEW/Book/Base.html">ReVIEW::Book::Base</a> <li><a href="./ReVIEW/Book/BibpaperIndex.html">ReVIEW::Book::BibpaperIndex</a> <li><a href="./ReVIEW/Book/Chapter.html">ReVIEW::Book::Chapter</a> <li><a href="./ReVIEW/Book/ChapterIndex.html">ReVIEW::Book::ChapterIndex</a> <li><a href="./ReVIEW/Book/ChapterSet.html">ReVIEW::Book::ChapterSet</a> <li><a href="./ReVIEW/Book/ColumnIndex.html">ReVIEW::Book::ColumnIndex</a> <li><a href="./ReVIEW/Book/Compilable.html">ReVIEW::Book::Compilable</a> <li><a href="./ReVIEW/Book/FootnoteIndex.html">ReVIEW::Book::FootnoteIndex</a> <li><a href="./ReVIEW/Book/FormatRef.html">ReVIEW::Book::FormatRef</a> <li><a href="./ReVIEW/Book/HeadlineIndex.html">ReVIEW::Book::HeadlineIndex</a> <li><a href="./ReVIEW/Book/IconIndex.html">ReVIEW::Book::IconIndex</a> <li><a href="./ReVIEW/Book/ImageFinder.html">ReVIEW::Book::ImageFinder</a> <li><a href="./ReVIEW/Book/ImageIndex.html">ReVIEW::Book::ImageIndex</a> <li><a href="./ReVIEW/Book/ImageIndex/Item.html">ReVIEW::Book::ImageIndex::Item</a> <li><a href="./ReVIEW/Book/IndepImageIndex.html">ReVIEW::Book::IndepImageIndex</a> <li><a href="./ReVIEW/Book/IndepImageIndex/Item.html">ReVIEW::Book::IndepImageIndex::Item</a> <li><a href="./ReVIEW/Book/Index.html">ReVIEW::Book::Index</a> <li><a href="./ReVIEW/Book/ListIndex.html">ReVIEW::Book::ListIndex</a> <li><a href="./ReVIEW/Book/NumberlessImageIndex.html">ReVIEW::Book::NumberlessImageIndex</a> <li><a href="./ReVIEW/Book/NumberlessImageIndex/Item.html">ReVIEW::Book::NumberlessImageIndex::Item</a> <li><a href="./ReVIEW/Book/PageMetric.html">ReVIEW::Book::PageMetric</a> <li><a href="./ReVIEW/Book/Part.html">ReVIEW::Book::Part</a> <li><a href="./ReVIEW/Book/TableIndex.html">ReVIEW::Book::TableIndex</a> <li><a href="./ReVIEW/Book/Volume.html">ReVIEW::Book::Volume</a> <li><a href="./ReVIEW/Builder.html">ReVIEW::Builder</a> <li><a href="./ReVIEW/Catalog.html">ReVIEW::Catalog</a> <li><a href="./ReVIEW/CompileError.html">ReVIEW::CompileError</a> <li><a href="./ReVIEW/Compiler.html">ReVIEW::Compiler</a> <li><a href="./ReVIEW/Compiler/InlineSyntaxElement.html">ReVIEW::Compiler::InlineSyntaxElement</a> <li><a href="./ReVIEW/Compiler/SyntaxElement.html">ReVIEW::Compiler::SyntaxElement</a> <li><a href="./ReVIEW/ConfigError.html">ReVIEW::ConfigError</a> <li><a href="./ReVIEW/Configure.html">ReVIEW::Configure</a> <li><a href="./ReVIEW/EPUBBuilder.html">ReVIEW::EPUBBuilder</a> <li><a href="./ReVIEW/EPUBMaker.html">ReVIEW::EPUBMaker</a> <li><a href="./ReVIEW/EPUBMaker/ReVIEWHeaderListener.html">ReVIEW::EPUBMaker::ReVIEWHeaderListener</a> <li><a href="./ReVIEW/EWBBuilder.html">ReVIEW::EWBBuilder</a> <li><a href="./ReVIEW/Error.html">ReVIEW::Error</a> <li><a href="./ReVIEW/ErrorUtils.html">ReVIEW::ErrorUtils</a> <li><a href="./ReVIEW/FileNotFound.html">ReVIEW::FileNotFound</a> <li><a href="./ReVIEW/HTMLBuilder.html">ReVIEW::HTMLBuilder</a> <li><a href="./ReVIEW/HTMLTOCPrinter.html">ReVIEW::HTMLTOCPrinter</a> <li><a href="./ReVIEW/HTMLToc.html">ReVIEW::HTMLToc</a> <li><a href="./ReVIEW/HTMLUtils.html">ReVIEW::HTMLUtils</a> <li><a href="./ReVIEW/I18n.html">ReVIEW::I18n</a> <li><a href="./ReVIEW/IDGTOCPrinter.html">ReVIEW::IDGTOCPrinter</a> <li><a href="./ReVIEW/IDGXMLBuilder.html">ReVIEW::IDGXMLBuilder</a> <li><a href="./ReVIEW/INAOBuilder.html">ReVIEW::INAOBuilder</a> <li><a href="./ReVIEW/KeyError.html">ReVIEW::KeyError</a> <li><a href="./ReVIEW/LATEXBuilder.html">ReVIEW::LATEXBuilder</a> <li><a href="./ReVIEW/LaTeXIndex.html">ReVIEW::LaTeXIndex</a> <li><a href="./ReVIEW/LaTeXUtils.html">ReVIEW::LaTeXUtils</a> <li><a href="./ReVIEW/LaTeXUtils/NKF.html">ReVIEW::LaTeXUtils::NKF</a> <li><a href="./ReVIEW/Line.html">ReVIEW::Line</a> <li><a href="./ReVIEW/LineInput.html">ReVIEW::LineInput</a> <li><a href="./ReVIEW/Location.html">ReVIEW::Location</a> <li><a href="./ReVIEW/MARKDOWNBuilder.html">ReVIEW::MARKDOWNBuilder</a> <li><a href="./ReVIEW/MakerHelper.html">ReVIEW::MakerHelper</a> <li><a href="./ReVIEW/PDFMaker.html">ReVIEW::PDFMaker</a> <li><a href="./ReVIEW/Preprocessor.html">ReVIEW::Preprocessor</a> <li><a href="./ReVIEW/Preprocessor/Directive.html">ReVIEW::Preprocessor::Directive</a> <li><a href="./ReVIEW/Preprocessor/Strip.html">ReVIEW::Preprocessor::Strip</a> <li><a href="./ReVIEW/Repository.html">ReVIEW::Repository</a> <li><a href="./ReVIEW/SecCounter.html">ReVIEW::SecCounter</a> <li><a href="./ReVIEW/SyntaxError.html">ReVIEW::SyntaxError</a> <li><a href="./ReVIEW/TEXTBuilder.html">ReVIEW::TEXTBuilder</a> <li><a href="./ReVIEW/TOCParser.html">ReVIEW::TOCParser</a> <li><a href="./ReVIEW/TOCParser/Chapter.html">ReVIEW::TOCParser::Chapter</a> <li><a href="./ReVIEW/TOCParser/List.html">ReVIEW::TOCParser::List</a> <li><a href="./ReVIEW/TOCParser/Node.html">ReVIEW::TOCParser::Node</a> <li><a href="./ReVIEW/TOCParser/Paragraph.html">ReVIEW::TOCParser::Paragraph</a> <li><a href="./ReVIEW/TOCParser/Section.html">ReVIEW::TOCParser::Section</a> <li><a href="./ReVIEW/TOCPrinter.html">ReVIEW::TOCPrinter</a> <li><a href="./ReVIEW/TOCRoot.html">ReVIEW::TOCRoot</a> <li><a href="./ReVIEW/TOPBuilder.html">ReVIEW::TOPBuilder</a> <li><a href="./ReVIEW/Template.html">ReVIEW::Template</a> <li><a href="./ReVIEW/TextTOCPrinter.html">ReVIEW::TextTOCPrinter</a> <li><a href="./ReVIEW/TextUtils.html">ReVIEW::TextUtils</a> <li><a href="./ReVIEW/Unfold.html">ReVIEW::Unfold</a> <li><a href="./ReVIEW/WrongInput.html">ReVIEW::WrongInput</a> <li><a href="./String.html">String</a> <li><a href="./UUID.html">UUID</a> </ul>
</nav>
</div>
</nav>
<div id=“documentation” class=“description”>
<h1 id=“label-Re%3AVIEW”>Re:VIEW<span><a href=“#label-Re%3AVIEW”>¶</a> <a href=“#documentation”>↑</a></span></h1>
<p><a href=“travis-ci.org/kmuto/review”>
src=“secure.travis-ci.org/kmuto/review.png”/>>
<a href=“
badge.fury.io/rb/review”>
src=“
” alt=“Gem Version”
/></a></p> <dl class=“rdoc-list
note-list”><dt>home <dd> <p><a href=“github.com/kmuto/review
<p>Re:VIEW is an easy-to-use digital publishing system for books and ebooks.</p>
<h2 id=“label-Format”>Format<span><a href=“#label-Format”>¶</a> <a href=“#documentation”>↑</a></span></h2>
<p>Re:VIEW uses its original format('Re:VIEW format') as source files. See doc/format.rdoc (in Japanese).</p>
<p>Output formats Re:VIEW supports are:</p> <ul><li> <p>EPUB</p> </li><li> <p>LaTeX(ptexlive)</p> </li><li> <p>InDesign(IDGXML)</p> </li><li> <p>plain text(TOPBuilder Text Markup Language)</p> </li><li> <p>Inao(gihyo.jp original markup)</p> </li></ul>
<h2 id=“label-Commands”>Commands<span><a href=“#label-Commands”>¶</a> <a href=“#documentation”>↑</a></span></h2>
<p>There are two commands generate files directly.</p> <ul><li> <p>review-epubmaker: generate EPUB file.</p> </li><li> <p>review-pdfmaker: generate PDF file using LaTeX(ptexlive).</p> </li></ul>
<p>And some useful commands.</p> <ul><li> <p>review-compile: compile Re:VIEW fomat files.</p> </li><li> <p>review-vol: figure out size of Re:VIEW files.</p> </li><li> <p>review-index: generate index with various format.</p> </li><li> <p>review-preproc: preprocessor.</p> </li></ul>
<h2 id=“label-Installation”>Installation<span><a href=“#label-Installation”>¶</a> <a href=“#documentation”>↑</a></span></h2>
<p>Install gem yourself as:</p>
<pre>$ gem install review</pre>
<p>Or build from source:</p>
<pre>$ git clone github.com/kmuto/review.git $ cd review $ rake install</pre>
<p>Or add the `./bin` directory to your $PATH:</p>
<pre>$ echo "export PATH=PATH_OF_REVIEW/bin:$PATH" >> ~/.profile</pre>
<h2 id=“label-Resources”>Resources<span><a href=“#label-Resources”>¶</a> <a href=“#documentation”>↑</a></span></h2>
<h3 id=“label-Documents”>Documents<span><a href=“#label-Documents”>¶</a> <a href=“#documentation”>↑</a></span></h3> <ul><li> <p>Wiki pages: <a href=“github.com/kmuto/review/wiki
github.com/kmuto/review/wiki”>github.com/kmuto/review/wiki> </li><li> <p>doc/* files (in Japanese)</p> </li></ul><h3 id=“label-Issues+tracker”>Issues tracker<span><a href=“#label-Issues+tracker”>¶</a> <a href=“#documentation”>↑</a></span></h3> <ul><li> <p>GitHub: <a href=“github.com/kmuto/review
github.com/kmuto/review”>github.com/kmuto/review> </li></ul><h2 id=“label-Note+on+Patches%2FPull+Requests”>Note on Patches/Pull Requests<span><a href=“#label-Note+on+Patches%2FPull+Requests”>¶</a> <a href=“#documentation”>↑</a></span></h2> <ul><li> <p>Fork the project.</p> </li><li> <p>Make your feature addition or bug fix.</p> </li><li> <p>Add tests for it. This is important so I don't break it in a future version unintentionally.</p> </li><li> <p>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)</p> </li><li> <p>Send me a pull request. Bonus points for topic branches.</p> </li></ul>
<h2 id=“label-License”>License<span><a href=“#label-License”>¶</a> <a href=“#documentation”>↑</a></span></h2>
<p>LGPL. See COPYING file.</p>
<h2 id=“label-Copyright”>Copyright<span><a href=“#label-Copyright”>¶</a> <a href=“#documentation”>↑</a></span></h2>
<p>Copyright © 2006-2015 Minero Aoki, Kenshi Muto, Masayoshi Takahashi, Masanori Kado.</p>
</div>
<footer id=“validator-badges”>
<p><a href="http://validator.w3.org/check/referer">[Validate]</a> <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0. <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
</footer>