mint (html file generator) Manual

last update: 2 May 2002

home |index |previous |next |contents

コントロールモードコマンド



これまでドキュメントモードコマンドについて説明しました。 これらは大まかにいえば文書の論理構造を制御するためのコマンドです。

他方、HTMLファイルの背景色や文字色、文字のサイズを指定したり、 場合によってはHTMLファイルを書き込むディレクトリを指定する必要もあります。
mintはこれらに対応するために、<%doc>と</%doc>の外部で使うコマンドも用意しています。 これらのコマンドをコントロールモードコマンドといいます。

以下にコントロールモードコマンドの解説をします。

8.1 %part
大規模なドキュメントを作成する際、パート別にhtmlファイルをまとめたい場合があります。 そのような時には%partコマンドを使用する事が出来ます。

%partコマンドを挿入した場所から新しいパートが始まります。
%partコマンドに続いてパートタイトルを記述してください。

例えば以下のようなソースファイルを作成した場合、


%part イントロダクション

<%doc part1.html>
<%title はじめに>
これはイントロダクションです。
</%doc>

%part 本題

<%doc part2-1.html>
<%title パート2:本題>
これはパート2の最初のhtmlファイルです。
</%doc>

<%doc part2-2.html>
<%title パート2のつづき>
これはパート2の2番目のhtmlファイルです。
</%doc>

%partの使用例


以下のような論理構造をもった文書になります。


Part 1: イントロダクション
    1. はじめに
Part 2: 本題
    1. パート2:本題

    2. パート2のつづき


8.2 %define, %undefine
現在の背景の色は白、文字の色は黒、sectionの帯の色は青となっていますが、 これらを%defineコマンドで変更することができます。
文字の色やサイズだけでなく、改行・改段落のコントロールなどもできます。

パラメータ一覧にすべてのパラメータとデフォルト値がまとめてあります。

%defineで一度変更したパラメータをもう一度元に戻すには、%undefineコマンドを使います。 つまりundo機能です。

#
# define の例
#
%define BGCOLOR black
%define TEXT white

<%doc define.html>
これは%defineのテストデータです。
<%/doc>

#
# undefine の例
#
%undefine BGCOLOR
%undefine TEXT

<%doc undefine.html>
これは%undefineのテストデータです。
<%/doc>

%defineと%undefineの例


8.3 %include
上に説明した%defineコマンドを使えば、好みの形式の表示をすることが可能ですが、 文字色や文字サイズ、背景色など多数のパラメータを文書毎にいちいち%defineコマンドで 指定するのは不便です。

このような面倒を避けるためにmintは%includeコマンドをサポートしています。
例えば、mintのデフォルトの背景色は白で文字色は黒ですが、 背景色は赤、文字色は白が好みだったとしましょう。

始めに好みの出力形式をインクルードファイル(sufixは"inc")、例えばexcite.incに書きます。


%define BGCOLOR red
%define TEXT white

excite.inc


そして、mintのソースファイル内において、%includeコマンドでインクルードファイルを設定します。 例えば以下のようにすれば、include.htmlというHTMLファイルの背景色は赤、文字色は白となります。

%include excite.inc

<%doc include.html>
これは%includeコマンドの使用例です。

</%doc>

インクルードファイルの使用例


なお、mintをインストールしたディレクトリのサブディレクトリlibに 標準のインクルードファイルが多数用意されています。 またREADMEも用意されていますので 適宜読んで下さい。

8.4 %add
%addコマンドはmintの機能拡張を行なうためのコマンドで、 現在のところ、以下の2つのオプションをサポートしています。


まあ、頻繁に使うコマンドではないので、覚える必要はないでしょう。 そういう作者も使ったことがありません。
8.5 %set
%setコマンドはmintの機能設定を行なうコマンドで、 現在のところ、以下の2つのオプションをサポートしています。

8.6 %meta
%metaコマンドは、生成するHTMLファイルのメタ情報を付加するためのコマンドで、 以下の6つのオプションをサポートしています。


%metaコマンドで設定するデータは、HTMLファイルのヘッダ部分に埋め込まれるため、 ブラウザ表示には影響を与えませんが、 サーチエンジンなどがこれらのデータを利用することもありますので、 指定したほうが良いでしょう。

%metaコマンドは、インクルードファイル中では使用できません。 これは著者や著作権など大事なデータを設定するコマンドなので、 各文書毎にこれらのデータを責任を持って記述するよう強制するためです。

8.7 %replace
%replaceコマンドは、文書中の文字列変換を指定するときに使います。 つまり、Cプリプロセッサの#define文と同じ働きをします。

例えば、"FILE"という文字列を"/home/mydir/myfile"という文字列に、 "COMMAND"という文字列を"ls -la"という文字列に変換したい時には、 以下のようにします。

また、複数の語からなる文字列(つまり、空白を含む文字列)は、ダブルクォーテーション(")で囲んで指定して下さい。

%replace COMMAND "ls -la"

%replace FILE /home/mydir/myfile

%replace OS  "Linux  2.2.13"

<%doc replace.html>
これはreplaceの例です。

<%comannd>
uname -srm
>OS		# この行は Linux  2.2.13 と表示される
COMMAND FILE	# この行は ls -la /home/mydir/myfile と表示される
>-rw-rw-rw root root 1002 Feb 14 10:12 FILE
</%command>
</%doc>

%replaceの例



home |index |previous |next |contents

Copyright @ 1999-2002, Hironobu Suzuki. All right reserved.