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

[82] Re: Samba Doc project and SmartDoc



三浦です

ぜひ、ほかの方のご意見もききたいですね。

In message "[sdocusersj 80] Re: Samba Doc project and SmartDoc"
    on 00/07/31, ASAMI Tomoharu <dp8t-asm@asahi-net.or.jp> writes:
>  浅海です。
> 
> Hiroshi MIURA <miura@samba.gr.jp> writes:
> 
> > SmartDocのターゲットと、わたしが当初想定した、オープンソースの
> > ドキュメント整備との違いを少し感じました。
> > 当初、manに代表されるへルプシステムのドキュメントを、そのソースを
> > XMLとすることで、man, html, tex, pdfへと展開できることを
> > 希望していました。
> 
>  roff -manの形式は、一般的なヘルプドキュメントというより、リファレン
> スマニュアル専用フォーマットというように理解しています。
>  SmartDocは汎用の技術ドキュメント用のフォーマットという位置付けなので、
> この点でroff -manとはターゲットが異なっています。

なるほど。ターゲットの違い。理解できました。roff -manの形式は、情報量
の少ない形式ですから、たいていの形式から変換するのは、容易であろうとは
想像がつきます。
また、manのドキュメント特有の項目だてというものもありますが、
それは、セクションのタイトルの付け方などの習慣でしかありませんから、
そのことが、SmartDocから変換するときの制約になることもないだろうと
おもいます。
 
> > しかしながら、helpシステムとして、SmartDocは、javahelp形式を
> > お考えのようで、たしかに古いman形式を考えると、それも仕方ないかな
> > とおもえました。
> 
>  多分、ここは若干の誤解があると思います。
>  JavaHelp自体はJavaプログラム用のフォーマットであり、一般的なヘルプシ
> ステムとはなり得ないでしょう。SmartDocがJavaHelp形式を出力できるのは、
> Javaプログラムの開発に必要なフォーマットであり、ボク自身の需要があるか
> らです。

これは、たとえがわるいですが、Windowsの開発者がWinhelp形式をうまく作れると
具合いがいいというのと、同等のことなのですね。
# javaにたいして、windowsを持ってくるのが一番悪いたとえだというのは
# 承知のうえです。:)

>  他のヘルプフォーマットがすでに要らなくなったと考えているわけではなく、
> 単に工数上の問題で実装していないだけという感じです。
>  技術的には、roff -manやtexinfoは比較的単純なフォーマットなので、XSLT
> を使えば、PureSmartDoc形式から簡単に変換できると思います。

なるほど、PureSmartDoc形式というのは、そういう用途に使えるわけですか。
XSLTなどは、わたしはこれからの勉強になるので、どなたか挑戦いただけると
うれしいです。

> > となると、一般のユーザに対するインターフェースとしては、
> > HTMLが有力かつ、おそらく唯一のように思えます。
> 
>  現時点で、汎用的なヘルプを目指すのであれば、HTMLを採用するのが妥当だ
> とは思います。roffやtexinfoは表組みや図が使えないのが大きな制約なので。

そうですね。図はともかく、表が使えるメリットは大きいですね。また、
近代的なプラットホームでは、少なくともlynxくらいは動作しますから、
htmlでマニュアルが提供されることに対する抵抗は、昔ほどではないだろうと
おもいます。
 
> > はい。roff -man 形式です。Texinfoのように、manを捨てる割りきりが
> > あってもいいのでしょうが、あまりに独自なのは受け入れられません。
> > わたしの認識では、info or manはあったほうが良いようにおもっていました。
> > もし、だめならHTMLでしょうか。
> 
>  ターゲットフォーマットのバラエティとしては、roff -manやtexinfoがある
> のは良いなぁと思います。

SmartDocは、htmlと、LaTeXが吐けるのですから、
Texinfoというのは不要なのではないでしょうか。
そこで、man xor info とわたしは考えています。man と infoの両方に
対応する必要も不要でしょう。

>  PureSmartDoc+XSLTで変換するのは簡単にできそうなのですが、どなたかチャ
> レンジされる方はいらっしゃらないでしょうか。

チャレンジしたいのは山々ですが、初学者にはちょっと無理のようです。
やっと、ピアソンの「XML構築ガイド」の10日めに突入したばかりですから。

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

一番よいのは、大口のユーザを獲得することです。わたしの知る、ドキュメント
関連の大口ユーザは、LDPやJF(jf.linux.or.jp)ですが、彼らは、DocBookで
すでに動いております。

Smabaユーザ会のスタッフでは、興味を持ってSmartDocに取り組んでいますから、
スタッフが気に入れば、翻訳で協力することも多少はできるとおもいます。

#約束はできませんが。
#そうでなくても、英和翻訳も滞っておりますので...

--
SAMBA User Group Japan, devel. staff    http://www.samba.gr.jp/
Linux Kernel Hack Japan 	http://lkh.linux.or.jp/ (Now Constructing)
Project BLUE 				http://www.blue.gr.jp/
LUGS:=YLUGダイエット部,TLUC関東支部,TLUG,CLUG,たん清,ダンケ,すぃすぃ
三浦広志 ----- MIURA, Hiroshi 		http://www.momokuri.org/