# $Id: ForDvlop.txt,v 1.1 1999/05/11 16:29:34 odakker Exp $
#
#  表題  理論マニュアル, 読書ノート管理ソフトェア開発ノート
#
#  履歴  1999/05/12  小高正嗣
#

■はじめに

  この文書は地球流体電能倶楽部理論マニュアル, 読書ノート, その他の研究
  ノート類を管理するソフトウェア(dcnote-*)の開発方針ノートである.

  理論マニュアル, 読書ノートプロジェクトについては

	dennou-t:/GFD_Dennou_Club/dc-arch/reviews/TEBIKI.reviews.txt
	dennou-t:/GFD_Dennou_Club/dc-arch/riron/TEBIKI.riron.txt

  を参照のこと.


■目的作業とソフトェア設計方針

  目的とする作業と基本的な方針は以下のとおりである.

    [1]. tex 等で作られた研究ノート類を www 上で閲覧可能な画像形式に変換
         する

         - 変換されるべき資源ファイルの形式は tex を想定している. 
           数学物理系の研究ノート類では数式の使用は不可避であり, tex を
           使用しなくなることはしばらくないであろうという判断に基づく. 
         - 変換する画像形式は gif と pdf を採用する. 
           latex2html を用いれば [1]及び下記[2]の作業を一括して扱えるが, 
           生成物を閲覧に耐える水準にするまでの作業コストが高いため使用
           しない.
         - 当初から画像形式, HTML 形式で作成された資源に対してはこの処理
           を行わない. 
         - その他の形式で作成された資源については当面考慮しない.
         - プロトタイプとして竹広真一氏作成 Dlatex2scan (dennou-*:
           /GFD_Dennou_Club/dc-arch/riron/tools/tools/Dlatex2scan )
	   を用いる.

    [2]. [1]等で作成した画像ファイルをくるんだ html ファイルを生成する

    [3]. [2]で作成した html ファイルを束ねる index.html を作成する.
         この index.html から一段上のディレクトリの index.html がたどれる
         ようにする.       

         - [2],[3]の作業を行うソフトウェアのプロトタイプとして gfdnote 
           (dennou-*:/GFD_Dennou_Club/dc-arch/zz1998/gfd-note 参照)
           保守用ソフトウェア群を用いる.
	 - 一段上のディレクトリに存在する index.html は mksigen(8) で作成
           するようにする.
	   

■ソフトウェアの基本動作

    [1]. tex から gif, pdf への変換

       1) platex 等で *.tex から *.dvi, *.aux を作成する.
       2) dvi2ps で *.dvi を *.ps へ変換する.

       ここまでの作業は gif , pdf 変換も同じ.
       gif にするには,

       3-1) convert で *.ps を 1 ページ枚の [0-9][0-9][0-9].pgm へ変換する.
       3-2) pnmtops で *.pgm を *.gif に変換する.

          (注: convert でも gif ファイルは生成できるが, ftp で配布されている
               バイナリは lzw 圧縮がかかってないので作成された gif のサイズ
               が大きいという問題がある.
               lzw 圧縮をかけられるようにするにはソースからコンパイルする
               必要がある)

       pdf にするには,

       3-3) ps2pdf で *.ps を *.pdf に変換する.       

       変更点は

	 ・convert 一発で gif に変換するようにする.
	   (convert(Imagimagic)をソースからコンパイルする)
	 ・設定ファイルを /etc/dcnote.conf とし, 下位使用コマンド類は
           このファイルで指定するようにする.


    [2]. 画像ファイルをくるんだ html ファイルを生成する

       gfdnote ソフトウェア群では

       bindnote.pl	html ファイル作成エンジン部分
       bindnote.sh	bindnote.pl 実行シェルスクリプト

       が担っていた部分である. 
       bindnote.pl の主な動作は以下の通りである.

         1) 引数に与えられたディレクトリ内を検索し, gif ファイル名を
            配列に渡す. 
         2) gif ファイルをくるんだ html ファイルを作成する.
	    このとき前のページと後ろのページをリンクする.
            リンクを表示する gif イメージも同時に張り付ける.

       変更点は

         ・カレントディレクトリにある gif ファイルを読み込むようにする.
           引数にディレクトリ名は与えない. 出力もカレントディレクトリに行う. 
	   リンク表示も同様.
	 ・張り付ける gif イメージファイルの置き場所は /usr/lib/dcnote/ 
           (新たに作成する)以下にする. 


    [3]. [2]で作成した html ファイルを束ねる index.html を作成する.

       gfdnote ソフトウェア群では       

       botscan.pl	index.html 作成プログラム

       が担っていた部分である. 
       botscan.pl の作成した index.html は 2 段上のディレクトリまでたぐれる
       ようになっている. そのためディレクトリの階層構造をあらかじめ知っている
       必要が生じる. その結果非常に複雑なソフトウェアになっている.


       変更点は

         ・一段上のディレクトリの index.html だけをたぐるようにする.
	 ・より上位ディレクトリにある index.html は mksigen(8) で作成
           するようにする.