ALTAでオンラインマニュアル

Post date: 2013/11/16 3:43:10

ALTAでオンラインマニュアルを使えるように改良しました。ALBでは各画面の右側にヒントが表示されオンラインマニュアルの代用をしていますが、ALTAにはPower Pointで作成したユーザガイドしかなく、使用中に参照するには不便でした。ALTAのオンラインマニュアルでは、操作中の画面で、Help->Alta Helpをクリックすれば、その画面の説明を見ることができます。あってあたり前の機能ですが、仕組みを作るのは結構苦労します。いろいろ検討した結果、ALTAで使っているQt(キュートと呼ぶらしいです）というGUIのHelpツールであるassistantを採用しました。また、マニュアルの作成には、非常にすぐれたオープンソースの文書作成ソフトであるSphinxを使用しています。Sphinxの良いところは、Rubyがプログラム作成を楽しくしてくれるように、文書作成を楽しくしてくれるところです。仕組みができたところで、今後は内容の充実です。プログラムの開発とドキュメントの作成の両方を楽しくやっていきたいと思います。なお一緒に楽しくやっていただける方には、Sphinxのインストールからお手伝いしますのでご連絡ください。