mint (html file generator) Manual

last update: 2 May 2002

home |next |contents

Part 1 : mintの紹介


MINT Manual


version 0.9.4c


この文書は7つのパートに分かれています。
  1. mintの紹介
  2. インストールと実行
  3. チュートリアル
  4. コマンドリファレンス
  5. FAQ
  6. mintのソースファイルの書き方
  7. Appendix

1.1 イントロダクション
"mint"は簡単な構文規則で書かれたテキストファイル(mintではソースファイルといいます)からHTMLファイル群を生成するツールです。

TeXとLaTeXの関係を知っている方なら、mintも理解しやすいと思います。 mintはHTMLのマクロ言語のようなもので、多数のHTMLファイルからなる文書を 統一的に扱うためにつくり出されました。 ですから数ページの小さな文書はもとより、数10ページから数100ページにおよぶドキュメントを 作るような場合に有効です。そのような文書作成をサポートする機能がたくさん組み込まれています。 もちろんこのマニュアルもmintで生成されています。

特徴は:


自分の好みのスタイルをインクルードファイルに記述すれば、何度もそのスタイルを使うことができますし、 何度も使う表現はマクロにすることもできます(もちろんそのマクロをインクルードファイルに書けば、何度も 再利用できます)。

一方、構文を必要以上に複雑化させないために、"mint"は以下のことをサポートしていません。 しかし、いずれも直接HTMLのタグを書き込む、またはマクロを使うことで実現可能です。


"mint"はLinux上のperl (5.003_03)で作られたスクリプトなので、 perlが動作する大抵のマシン上で実行可能だと思います。
1.2 Version 0.8系からの変更点
以下の変更が加わりました。

  1. プレーンテキストからの変換
    プレーンテキストをmintのソースに変換する"-p"オプションを追加。
  2. テンプレートの出力
    テンプレートを出力する"-t"オプションを追加。
  3. <%contents>のオプション拡張とバグフィックス
    オプションとして"chapter"を使えるようにした。
    また、version 0.8.0は%part宣言がないと目次を表示しなかったが、 現バージョンでは改善させた。
  4. mint実行時"-a"オプションの追加
    version 0.9.2までは、mintはソースファイルに記述されたすべてのHTMLを生成していたので、 内容的には変更されていないHTMLファイルであってもアップデイトされた 新しいHTMLファイルのように表示されてしまい、不都合がありました。
    version 0.9.3以降、デフォルトでは新旧のHTMLファイルを比較し、変更があった場合のみHTMLファイルを更新するようにし、 すべてのHTMLファイルを無条件に更新したい場合には"-a"オプションを使うようにします。

またversion 0.9.2より、さまざまな背景色やセクションの表示スタイルを表現するインクルードファイルの ライブラリを充実させました。 READMEを参照してください。

1.3 mintの歩み
"mint"はある晩、perlで実験的に作った400行程度のプログラムが元になっています。

当初、HTMLファイルを簡便に生成することが最大の目的でしたが、プログラミングを進めるうちに 他のWEBページを見る時に感じる不便さ:

なども自動的に解消できるような機能を付け加えました。

そして正味3週間程度を費やして現在の"mint"の原型が出来ました。 その後、大幅な改良とデバッグを繰り返して現在のmintになりました。
1.4 謝辞
HTMLをほとんど知らずにmintを作り始めたので、Moe Hara嬢にはいろいろとHTMLについて教授を受けました。 感謝します。

1.5 総目次


Part 1: mintの紹介
    1. MINT Manual
      1.1.イントロダクション
      1.2.Version 0.8系からの変更点
      1.3.mintの歩み
      1.4.謝辞
      1.5.総目次
Part 2: インストールと実行
    1. インストールと実行
      1.1.インストール
      1.2.実行
        1.2.1.オプション
Part 3: チュートリアル
    1. チュートリアル
    2. 一番簡単な例
    3. mintの例
    4. mintの実行
    5. ドキュメントモードとコントロールモード
      5.1.ドキュメントモードとコントロールモード
      5.2.ドキュメントモードコマンド
      5.3.コントロールモードコマンド
    6. ドキュメントモードコマンド 1
      6.1.<%title> と <%subtitle>
      6.2.<%section>, <%subsection> & <%subsubsection>
        6.2.1.subsectionの例
          6.2.1.1.subsubsectionの例
      6.3.<%contents>
      6.4.<%url>
    7. ドキュメントモードコマンド 2
      7.1.<%screen>
      7.2.<%box>
      7.3.<%command>
      7.4.<%quote>
      7.5.<%enumerate>, <%item> & <%enum>
        7.5.1.<%enum>
        7.5.2.<%item>
        7.5.3.<%enumerate>コマンドのネスト
      7.6.<%table>, </%table>
    8. コントロールモードコマンド
      8.1.%part
      8.2.%define, %undefine
      8.3.%include
      8.4.%add
      8.5.%set
      8.6.%meta
      8.7.%replace
    9. コメントアウト
        9.0.1.;
        9.0.2.%coment
    10. 表記方法
      10.1.特殊文字
      10.2.スペースを含む文字列
      10.3.改行
    11. マクロ
      11.1.マクロの定義方法と使用方法
      11.2.パラメータの与え方
Part 4: コマンド リファレンス
    1. コマンドリファレンス
    2. ドキュメントモードコマンド 1
      2.1.<%doc> & </%doc>
      2.2.<%section>, <%subsection> & <%subsubsection>
      2.3.<%title> & <%subtitle>
      2.4.<%contents>
      2.5.<%url>
    3. ドキュメントモードコマンド 2
      3.1.<%enumerate>
      3.2.<%box>
      3.3.<%screen>
      3.4.<%command>
      3.5.<%quote>
      3.6.<%table>
    4. コントロールモードコマンド
      4.1.%part
      4.2.%define & %undefine
      4.3.%add
      4.4.%set
      4.5.%include
      4.6.%meta
      4.7.%replace
      4.8.%macro & /%macro
Part 5: FAQ
    1. FAQ
      1.1.基本的な操作
      1.2.表示について
      1.3.特殊な表示について
      1.4.その他
Part 6: mintのソースファイルの書き方
    1. mintのソースファイルの書き方
      1.1.プレインテキストからの変換
        1.1.1.簡単な例
        1.1.2.実行
        1.1.3.表示規則
          1.1.3.1.章節分け
          1.1.3.2.列挙
      1.2.テンプレートによる方法
Part 7: Appendix
    1. コマンド一覧
      1.1.ドキュメントモードコマンド
        1.1.1.1ラインコマンド
        1.1.2.モードコマンド
      1.2.コントロールモードコマンド
    2. パラメータ一覧




home |next |contents

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