Re: help document

[Takeshi AIHANA <aihana@xxxxxxxxxxxxxxx>]

こんにちは、相花です。

At Thu, 20 Feb 2003 17:42:55 +0900 (JST),
Masatake YAMATO wrote:
---
> 大和です。
> 
> 質問です。yelpで表示可能なドキュメントの形式は何でしょうか。

man, info, html, xml などあります。
xml は自前で yelp-pregenerator などで (xsltproc とスタイルシートを使い)
html を生成して表示します。

> 私はautotraceというコマンドラインベースのソフトウェアの開発に参加して
> います。最近になってドキュメントを書きたいというボランティアが出現した
> のですが、どのフォーマットでドキュメントを書いてもらうか決めかねています。
> 
> 私はfrontlineというautotraceに対するGtk+/GnomeベースのGUIフロントエンド
> の作者でもあります。そこで、そのボランティアが書いてくれる予定のautotraceの
> ドキュメントをfrontlineでも使い回したいと考えて、上述の質問をしました。

アプリのヘルプという意味でしたら、
docbook 形式の xml が GNOME-2 での標準です (see ${datadir}/gnome/help 以下)。
ちなみにエンコーディングは UTF-8 なので、
EUC-JP で作成したものを iconv などで変換します。

インストールの構造や Makefile 関連は、topdir の Makefile.am、各 help 以下を参照してみてはいかがでしょう。
*.xml (ドキュメント本体)
*-ja.omf (scrollkeepr でヘルプの目録を作るのに必要なファイル。
          特に無くても表示できますが、左側の目録ツリーが表示されます。
          ${datadir}/omf 以下を参照)
figures/ (ヘルプに表示する png 画像を配置する。)

---
(相花)