1.2 基本的な操作

Guidemaker は、body.txt という文書（今読んでいるこの文書の原稿となります）ファイルをもとに、目的とする HTML ファイル群を generate します。そのための shell script が mkdocs.sh です。このとき、別に用意しておいた画像ファイルなども集めて HTML ディレクトリ以下に完全なドキュメント群が作成されます。

つまり body.txt を作り、./mkdocs.sh とやって shell script を起動すれば HTML ディレクトリ以下に HTML ファイル群、画像ファイル群が揃っている、というわけです。

基本的な構造とそのための操作

ブラウザでこの HTML/index.html ファイルにアクセスすれば、出来具合いが確認できますから、完成すればそのまま HTML ディレクトリごと、どこかの Web ディレクトリにコピーすれば良いでしょう。必要なものはすべて HTML ディレクトリにそろっていますので、ただディレクトリごとコピーするだけで良いはずです。

mkdocs.sh の動き

このスクリプトの中身は以下のようになっており、mkdocs1.pl という Perl プログラムが画面左側の目次列にあたる _contents.html を合成し、続いて mkdocs2.pl が同右側のページ群にあたる HTML ファイル群を合成します。その後、RESOURCES ディレクトリに含まれている画像ファイルと index.html ファイルを HTML ディレクトリに複写して、ドキュメントとして読める状態になります。

./mkdocs_i.pl body.txt > index.dat
cat mkdocs_chead.dat > _contents.html
./mkdocs_c.pl index.dat >> _contents.html
cat mkdocs_ctail.dat >> _contents.html
./mkdocs_b.pl index.dat body.txt 
cp -rp RESOURCES/* HTML
mv _*.html HTML
exit