シンプルぱっと2のドキュメント

Posted on :| コメント (0) | トラックバック (0)

 シンプルぱっと2のドキュメント作成を開始しました。今は元になる原稿をWiki上で書いてます。 Wikiはウェブ上で利用するコンテンツ管理システムCMSの一種ですが、決まった書式に簡単に整形できるので、重宝しています。 ソフト専用サイトが立ち上がったときには、Wikiもあわせて設置する予定です。

 Wikiはテキスト文章を簡単にHTMLに変換してくれるため、手間暇かけずにドキュメントを仕上げるのには向いています。しかも、 基本的に誰でも編集できるようになっているため、ネットワークを通じて複数の人と共同作業ができます(今回は吉田一人で利用していますが)。

 しかし、Wikiにも欠点があります。印刷はできるのですが、ローカルのHDDに保存できないという点です。 ソフトウェアといっしょに配付する文章は、オフラインで閲覧できなければなりません。そこで、 WikiをWindowsのヘルプ形式であるHTMLヘルプ(CHM)に変換する必要があります。

 CHMファイルはシンプルぱっとでも使っているので、すでにご存じの方も多いでしょう。要はホームページをウェブサイトではなく、 HDD内で閲覧できるようにしたファイル形式です。

 さて、WikiからHTMLヘルプに変換するにはどうすればよいでしょう? WikiHelpMakerというソフトが公開されていますが、 吉田のWikiはスキンを変更しているため、うまく変換できませんでした。 コレが使えるとウェブ上のヘルプファイルが一発で変換できて楽なのですが。

 あれこれ検討した結果、 「ひとりWiki」というソフトを使うことにしました。Wikiは通常ウェブサーバー上で動作しますが、 ひとりWikiはWindows上で単体稼働します。ウェブ上に公開しているWikiを自動でひとりWikiに取り込むことはできませんが、 Wikiの元になっている文章はそのまま貼り付けられます。
 つまり、一手間かかりますが、いちいちHTMLエディタで編集せずとも、 Wikiで作ったヘルプファイルが流用できるだけでもだいぶ助かります。

 これで再編集したヘルプファイルをHTMLで出力し、ヘルプましんなどのHTMLヘルプ作成ツールに通せば、 配付可能なHTMLヘルプができます。

 シンプルぱっと2のドキュメントですが、常に最新のドキュメントを掲載したいので、オンラインドキュメントをメインに考えています。 しかし、それでは不親切なので、必要最低限の内容をHTMLヘルプとしてソフトに添付する予定です。そのためには、 ウェブ上の文章とヘルプファイルの連携がとりやすい形式が望ましいため、あれこれと検討してみました。

トラックバック

このエントリーのトラックバックURL:

コメント

コメントフォームに記入し投稿してください





Search
最近の記事
カテゴリー
過去の記事
Comments
TrackBacks
Feed
Powered by