ITエンジニア/デザイナ向けにオープンソースを毎日紹介

ReVIEWはRuby製のオープンソース・ソフトウェア。最近は技術者やデザイナーなど第一線で活躍される方が書籍を執筆するパターンが増えてきた。技術が複雑化、多様化する中でライターという属性だけではカバーしきれなくなっているのだろう。情報が求められる速度も早くなっている。


ピクチャ 498.png

分量チェック

 

技術書籍を執筆する際にテキストエディタを使う人は多いと思うが、表や図を埋め込んだり引用したりする際にフォーマットを適切に設定するのは非常に面倒だ。そこで使ってみたいのがReVIEWだ。書籍を執筆する上で役立つ機能を多数提供している。

一つはフォーマット変換機能だ。Wikiのような記法を覚えればテキストファイル(拡張子は.re)からHTMLやLaTeXフォーマットに変換してくれる。見出し、リスト、テーブル、引用など様々な記法が使える。さらにインデックスファイル(CHAPS)を使ってファイルを分離しておけるのも良い。


ピクチャ 504.png

出力されたHTMLファイル

 

さらにプリプロセッサがあり、予め指定した外部ファイルの内容を取り込むことができる。これによってソースファイルの引用が容易になるはずだ。その他目次の出力、分量の確認ができたり、動作するか不明ながら用語の説明済みかどうかチェックする機能などもある。

書籍に限らずソフトウェアの説明やオープンソースプロジェクトのリファレンスなどに活用できそうだ。記法がテキストファイル+α程度なのですぐに習得できるのも便利だ。

執筆時のバージョン

 リビジョン:4333

 

青木日記 2008-06-23

 http://www.loveruby.net/d/20080623.html

Revision 4333: /review

 http://i.loveruby.net/svn/public/review/

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2