mint (html file generator) Manual

last update: 29 Sep 2004

• 記法
  

  %part TITLE
  

• 機能
  %partコマンドは、パート別にhtmlファイルをまとめる。 大規模なドキュメントを作成する際などに使用できる。
  

  %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のつづき
  

  
  

• パラメータ
  %defineコマンドを使って、以下のパラメータを制御できる。
  

  パラメータ名	機能	値域	デフォルト値
  parttitlecharcolor	パートタイトルの文字の色	rgb	#000088
  parttitlefontsize	パートタイトルの文字サイズ	1 .. 6	4
  parttitle	パートの先頭HTMLページにパートタイトルをつけるか否か	yes , no	yes
  parttitlepostion	パートタイトルの表示位置	center, left, right	left

  
  

• 記法
  

  %define IDENTIFIER TOKEN-STRING
  
  %undefine IDENTIFIER

• 機能
  %defineコマンドはmintのデフォルトパラメータを変更するために使う。 %undefineコマンドは%defineで変更したパラメータをもう一度元に戻すときに使う。
  

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

  %define, %undefineコマンドはソースファイル内とインクルードファイル中に記述できる。
  

• 記法
  

  %add option -[A-z] LAVEL
  %add path PATH

  
  
• 機能
  %addコマンドは2つの機能を有する。
  1. ナビゲーションバーの新しいキーの設定
     

     %add option -[A-z] LAVEL
     

     ナビゲーションバー用のシンボルとラベルを設定する。
     

     例えば、ナビゲーションバーに"back"というラベル(シンボルは"-b")を作る場合、 コントロールモード中で以下のように設定する。
     このように設定すれば、以降%コマンドにおいて、"-b"というオプションを使う事が出来る。
     

     %add option -b back <%doc example.html -b home.html> .... 略 ....

     optionの使用例

     
     
  2. サーチパス(SearchPath)の設定
     

     %add path PATH

     
     %includeコマンドで読み込むインクルードファイルのディレクトリを登録する。
     

     例えば、自作のインクルードファイルがディレクトリ/home/yourdir以下にある場合、 以下のように設定することで、絶対パスでインクルードファイルを指定する必要がなくなる。
     

     %add path /home/yourdir %include myincludefile.inc <%doc path.html> これはpathオプションの例です。 </%doc>

     pathオプションの例

     
     
  
  %addコマンドはソースファイル内とインクルードファイル中に記述できる。
  

• 記法
  

  %set installdir DIRECTORY
  %set workdir DIRECTORY

  
  
• 機能
  %setコマンドは2つの機能を有する。
  1. インストールディレクトリの設定
     

     %set installdir DIRECTORY

     
     htmlファイルを書き込むディレクトリを指定する。
     mintを使用してhtmlファイルを生成する場合、 デフォルトではカレントディレクトリにhtmlファイルが生成されるが、 以下のように指定することでhtmlファイルを任意のディレクトリに書き込むことができる。
     

     %set install /home/mydir <%doc mydoc.html> これはinstalldirの例です。 </%doc>

     installdirの使用例

     
     この場合、mydoc.htmlファイルは/home/mydirディレクトリに生成される。
     
  2. 作業ディレクトリの設定
     

     %set workdir DIRECTORY

     (作業用)テンポラリファイルを生成するディレクトリを指定する。
     mintは動作時にいくつかのテンポラリファイルを作る。 デフォルトではそれらはカレントディレクトリに生成されるが、
     

     %set workdir /tmp <%doc workdir.html> これはworkdirの例です。 <%contents> </%doc>

     workdirの使用例

     
     このように設定すると、テンポラリファイル、コンテンツファイルはディレクトリ/tmpに 生成される。
     
  
  %setコマンドはソースファイル内とインクルードファイル中に記述できる。
  

• 記法
  

  %include INCLUDE-FILE

• 機能
  インクルードファイルを読み込む。
  

  %includeコマンドは再帰呼び出しが出来る。つまり、%includeコマンドで読み込んだインクルードファイル中も %includeコマンドを書くことができる。
  

  mintは%includeコマンドでインクルードファイルを指定されたとき、以下の順にディレクトリを探す：

  1. カレントディレクトリ
  2. "%add path"コマンドで設定されたディレクトリ
  3. mintの変数"$INCLUDEPATH"に設定されたディレクトリ
  
  インクルードファイル中には以下のコマンドを書くことができる:
  

  %define, %undefile, %add, %include, %macro, /%macro

  
  

• 記法
  

  %meta author AUTHOR'S NAME
  %meta copyright COPY RIGHT TERMS
  %meta generalkeywords KEYWORD,KEYWORD,...
  %meta keywords KEYWORD,KEYWORD,...
  %meta lang LANG
  

  
  
• 機能
  %metaコマンドは 生成するHTMLファイルのメタ情報を付加するためのコマンドである。
  %metaコマンドで設定するデータは、HTMLファイルのヘッダ部分に埋め込まれるため、 ブラウザ表示には影響を与えない。
  %metaコマンドは、インクルードファイル中では使用できない。 これは著者や著作権など大事なデータを設定するコマンドなので、 各文書毎にこれらのデータを責任を持って記述するよう強制するためである、
  

  現在のところ、以下の6つの値を設定できる。

  1. author
     HTMLファイルの著者を指定する。

     %meta author AUTHOR'S NAME

     
     
  2. copyright
     HTMLファイルの著作権を記述する。

     %meta copyright COPY RIGHT TERMS

     
     
  3. generalkeywords
     文書全体のキーワードを指定する。 各キーワードは","で区切って記述する。
     

     %meta generalkeywords KEYWORD,KEYWORD,...

     
     
  4. keywords
     直後のHTMLファイルのキーワードを指定する。

     %meta keywords KEYWORD,KEYWORD,...

     
     
  5. lang
     

     HTMLファイル中で使用する言語を指定する。 以下の言語を使用できる。
     ja|en|es|de|it|nl|el|pt|ar|he|ru|zh|hi|ur|sa|fr|en-US|en-cockney|i-navajo|x-klingon
     %meta lang LANG

     
     

  6. description
     文書の説明。keywordsと同様、サーチエンジン対策。必ず、一行にすべての文章を書くこと。
     

     %meta description Brah, Brah, Brah

     
     

• 記法
  

  %replace SEARCH-WORD REPLACE-WORD
  %replace SEARCH-WORD "REPLACE-PHRASE"

• 機能
  Cプリプロセッサの#defineコマンドと同様の機能を持ち、 文書中のSEARCH-WORDを、REPLACE-WORDか"REPLACE-PHRASE"に置き換える。
  

  複数の語からなる語句( = REPLACE-PHRASE)の場合、ダブルクオート(")で囲む。
  

  以下に%replaceコマンドの使用例を示す。ドキュメントモード中の"WEBsite"と"equation"という語句は、 それぞれ"http://www.einstein.co.jp"と"E = M * C^2"という語句に変換されて表示される。
  

  %replace WEBsite http://www.einstein.co.jp %replace equation "E = M * C^2" <%doc replace.html> この方程式： equationは次のURLで説明されています。 <%url WEBsite> </%doc>

  %replaceの例

  
  

4.8 %macro & /%macro

• 記法
  

  %macro MACRONAME
  %macro MACRONAME PARAMETER ...
  
  /%macro
  

• 機能
  マクロの定義を行なう。
  

  マクロの定義は、コントロールモード中で行なう。
  例として、画像を表示するマクロimage1を定義する。 マクロimage1はパラメータIMAGEとして画像データを指定する。
  

  %macro image1 IMAGE <CENTER> <IMG SRC="IMAGE"> </CENTER> /%macro

  マクロの例: image1

  
  

  定義されたマクロはドキュメントモード中で使用する。
  

  <%doc macro1.html> 以下に私の画像データを表示します。 <%image1 myimage.gif> </%doc>

  マクロimage1の使用例

  
  このようにマクロを定義した後は、 ドキュメントモード中で新しいコマンドのようにマクロimage1を使う事が出来る。
  

  次に、パラメータの与え方について説明する。 上に定義したマクロimage1を拡張して、表題付きのイメージを出力するマクロimage2を 定義する。ここでは2つのパラメータ："IMAGE"と"TITLE"を指定できるようになっている。
  

  %macro image1 IMAGE TITLE <CENTER> <IMG SRC="IMAGE"> <BR> <U>TITLE <BR> </CENTER> /%macro

  マクロの例: image2

  
  

  使用例は以下の通り。実際に使う時には、具体的なパラメータ値を書き込む。
  

  <%doc macro2.html> 以下に私の画像データを表示します。 <%image2 myimage.gif "私の 画像 データ です"> </%doc>

  マクロimage2の使用例

  
  上記のようにパラメータに一語以上、もしくは空白を含む文字列を指定したい時には、 ダブルクオート(")で文字列を囲んで指定する。
  

home |index |previous |next |contents

since 04/Oct/2004