[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[80] Re: Samba Doc project and SmartDoc



 浅海です。

Hiroshi MIURA <miura@samba.gr.jp> writes:

> SmartDocのターゲットと、わたしが当初想定した、オープンソースの
> ドキュメント整備との違いを少し感じました。
> 当初、manに代表されるへルプシステムのドキュメントを、そのソースを
> XMLとすることで、man, html, tex, pdfへと展開できることを
> 希望していました。

 roff -manの形式は、一般的なヘルプドキュメントというより、リファレン
スマニュアル専用フォーマットというように理解しています。
 SmartDocは汎用の技術ドキュメント用のフォーマットという位置付けなので、
この点でroff -manとはターゲットが異なっています。

> しかしながら、helpシステムとして、SmartDocは、javahelp形式を
> お考えのようで、たしかに古いman形式を考えると、それも仕方ないかな
> とおもえました。

 多分、ここは若干の誤解があると思います。
 JavaHelp自体はJavaプログラム用のフォーマットであり、一般的なヘルプシ
ステムとはなり得ないでしょう。SmartDocがJavaHelp形式を出力できるのは、
Javaプログラムの開発に必要なフォーマットであり、ボク自身の需要があるか
らです。
 他のヘルプフォーマットがすでに要らなくなったと考えているわけではなく、
単に工数上の問題で実装していないだけという感じです。
 技術的には、roff -manやtexinfoは比較的単純なフォーマットなので、XSLT
を使えば、PureSmartDoc形式から簡単に変換できると思います。

> となると、一般のユーザに対するインターフェースとしては、
> HTMLが有力かつ、おそらく唯一のように思えます。

 現時点で、汎用的なヘルプを目指すのであれば、HTMLを採用するのが妥当だ
とは思います。roffやtexinfoは表組みや図が使えないのが大きな制約なので。

> はい。roff -man 形式です。Texinfoのように、manを捨てる割りきりが
> あってもいいのでしょうが、あまりに独自なのは受け入れられません。
> わたしの認識では、info or manはあったほうが良いようにおもっていました。
> もし、だめならHTMLでしょうか。

 ターゲットフォーマットのバラエティとしては、roff -manやtexinfoがある
のは良いなぁと思います。
 PureSmartDoc+XSLTで変換するのは簡単にできそうなのですが、どなたかチャ
レンジされる方はいらっしゃらないでしょうか。

> これは、オープンソースのつよみで、プロジェクトを結成して
> マニュアル作成するのがよいでしょう。
> #ただし、このところ、人材不足の感は否めない

 なんとか、こういう形にできればよいですね。

> ありがとうございます。まずは、samba-jpのメンバーが使ってみています。
> なにかあったら、また投稿します。

 よろしくお願いします。

-- 
あさみ@よこはま (http://www.netpassport.or.jp/~wtasami/)