namazu-dev(ring)


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

Disclosing a Catfish-the-DOC project



Bansoukouです。

namazu-dev #1416で誰かが、

> man をコーディングするより、man を自動生成するツールをコーディ
> ングしてもらえると嬉しいです。:-)

というので、真に受けてまじめに作っております。HTML/MANページを
半自動で吐き出してくれるソフトです。

Namazu2.0の公開には微妙に間に合いそうにない気がしますが、
そろそろ目処がついてきましたので、一応、そういうプログラム
を作っているということを宣言しておきます。

Namazu用のヘルプソフトですので、Catfishという名称にしようかと
思います。概要は次のとおりです。

1.作成したいMANページやHTMLページの元ねたになる原稿は
  XML形式のファイルで作成する。DTDも含め、XML1.0に沿った
  形式であれば、ちゃんとパースして読み込んでくれます。

2.レイアウト情報は、独自の記述ファイルを用意して出力
  させる。
  本来は、XSLを利用して変換するようにしたかったのですが、
  残念ながら、現状ではフリーで使えるXSLのシステムがない
  ので、やむなく独自形式にしました(利用する開発環境が
  Javaなら多少はあるようですが)。
  UN*X man形式用とHTML用を用意しておけば、同一の原稿から
  別々のフォーマットの原稿を吐き出してくれます。
  この時、元の原稿に記載されていた情報のどの部分を出力
  するのか、どういった順序で出力するのかもコントロール
  することが可能です。

3.開発言語はC/C++です。Perlか何かで簡単に済ますことも
  考えたのですが、データの形式にちゃんとしたXMLを使え
  るほうが長期的にはメリットが大きそうなので、こういう
  ことにしました。

ソフトのコンパイルと動作には、Apacheグループが配布している
フリーのXMLパーサーを利用します。従って、このパーサーが
動作する環境でないと使えません(RedHat Linux6.0はOKですが、
FreeBSDは駄目だったりします)。
詳細はxml.apache.orgを参照してください。

Namazuプロジェクトで利用してもらえるようなら、とりあえず
評価用に利用しているdtdとサンプルXMLファイルを配りますの
で、その形式で文書をコーディングしていただけると、manと
HTMLに変換することは可能かと思います。

ソフトのほうは、もう少し作業が進んだら、開発版を公開でき
るかと思います。

興味があったら、お返事ください。

---------------------------
Bansoukou
Email: bansoukou@xxxxxxxxxxxx