mintのソースファイルの書き方

プレインテキストからの変換と、テンプレート

mintのソースファイルを書くにはさまざまなコマンドを使って書く必要があり、全くの白紙状態からの出発は相当な負担となります。

そこでmintは、簡便にソースファイルを書くためのオプションとして、以下の二つの方法をサポートしています(version 0.9.0より)。

プレーンテキストからソースファイルを生成

テンプレートを出力

以下にこれらの方法について説明します。

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

1.1 プレインテキストからの変換
mintの"-p"オプションは、plain2のように、プレーンテキストからmintのソースファイルを生成する機能です。

現在のところ、以下の二つについてmintのソースファイルに自動的に変換します。

章節分け

列挙

始めに簡単な例を示し、その後に詳細な記述方法を説明します。

1.1.1 簡単な例

1. mint
これからmintについて説明しましょう。

1.1. 歴史
1998年の11月に、htmlファイルによる文書を簡単に作る
フィルタソフトとして誕生しました。
最初はわずか400行程度だったと思います。

1.2. 現状
それが今や6700行にもふくれ上がってしまいました。

2. mintの使い方
2.1. ソースファイルの書き方
まずはソースファイルを書いて下さい。

以下の3つの方法があります:
	a) エディタでガリガリmintのコマンドを打ち込む
	b) プレインテキストを"mint -p"でソースファイルに変換する
	c) "mint -t"でテンプレートを出力し、編集する

2.2. 実行方法
マニュアルを読んで下さい:-)

プレインテキストの例：plain_text

%meta author --YOURNAME--
%meta copyright Copyright @ --YEAR--, --YOURNAME--. All right reserved.
%meta generalkeywords --ANY KEYWORDS--
%meta lang ja  ; for example.

%document -- DOCUMENT NAME --
;%set installdir --DIR--

%define home ../index.html
%define contents ./index.html#contents
%define sectionbgcolor  #77EE55

;%part -- PART TITLE --

<%doc node1.html>
<%title mint>
これからmintについて説明しましょう。

<%section 歴史>

1998年の11月に、htmlファイルによる文書を簡単に作る
フィルタソフトとして誕生しました。
最初はわずか400行程度だったと思います。

<%section 現状>
それが今や6700行にもふくれ上がってしまいました。

</%doc>

#
#
; %part --- part title --- if you want.
#
<%doc node2.html>
<%title mintの使い方>
<%section ソースファイルの書き方>
まずはソースファイルを書いて下さい。


以下の3つの方法があります:
<%enumerate>
  \<%enum エディタでガリガリmintのコマンドを打ち込む>
  
  \<%enum プレインテキストを"mint -p"でソースファイルに変換する>
  
  \<%enum "mint -t"でテンプレートを出力し、編集する>
  
</%enumerate>

<%section 実行方法>

マニュアルを読んで下さい:-)
</%doc>

plain_textから生成されたmintのソースファイル

1.1.2 実行

% mint -p plain_text > mint_source

1.1.3 表示規則

章節を指定する場合には必ず行頭から数字を書く。そして数字の後にはコンマ"."をつける。

列挙を行なう場合には必ず行頭に1つ以上の空白を入れる。

1. これは第1章の見出しです。

1.1. これは第1節の見出しです。

  a) これは列挙です。
  b) これも列挙です。

  1. これはインデントされて、行頭に空白があるので、列挙です。

  2. これも列挙です。

1.1.3.1 章節分け

基本形
サポートしているのはchapter、section、subsection、およびsubsubsectionです。

章節表記法の例

chapter 1.

section 1.1.

subsection 1.1.1.

subsubsection 1.1.1.1.
- 見出しをつける場合には数字と"."の後に、少なくともひとつの空白を空けてから見出しをつけて下さい。

1.1.3.2 列挙

列挙には「数えあげ列挙」と「列挙」があります。

数えあげ列挙
以下の表記で数えあげ列挙を行なうことが出来ます。(mintの<%enum>コマンドに変換)
数えあげ列挙の基本は数字か英文字の一文字ですが、括弧でくくるなど、バリエーションをつけることが出来ます。

以下に例を示します。

基本形	バリエーション
1, 2, 3,という数字の列挙	1) (2) 3] [4] 5. など
a, b, c,....やA, B, C,...のような英文字の列挙	a) (b) c] [D] E. など
a1, a2, a3のような、英文字に数字を組み合わせた列挙	a1) (b2) c3] [d4] e5. など

列挙
以下の表記で列挙を行なうことが出来ます。(mintの<%item>コマンドに変換)

基本形	バリエーション
*	** など
+	++ など
-	-- など

諸注意
1. 行頭に必ず空白が必要です。
  mintは行頭に空白があるか否かで、章や節などの文章の区切りなのか、列挙を行なっているのかを判断します。

1.2 テンプレートによる方法

例えば、以下のコマンドで"Examle"というソースファイルのテンプレートを生成できますので、それをさらに編集すれば効率良くHTMLファイルを作成できます。

% mint -t > Example

以下にテンプレートオプションで生成されたファイル:Exampleを示します。

; Put your data
%meta author --YOURNAME--
%meta copyright Copyright @ --YEAR--, --YOURNAME--. All right reserved.
%meta generalkeywords --ANY KEYWORDS--
%meta lang ja  ; for example.

; Write document name
%document -- DOCUMENT NAME --

; Write a data if you want.
;%set installdir --DIR--

; Examples.
%define home ../index.html
%define contents ./index.html#contents
%define sectionbgcolor  #77EE55

; 
;%part -- PART TITLE --

; Start document
<%doc HTML.html -h -i -p -n -c>
<%title -- TITLE -->

    Write your document.
    ....
    ....
    ....

</%doc>



/%comment

テンプレートオプションで生成されたファイル:Example

このテンプレートを基に適宜、文章とmintのコマンドを入力してソースファイルを作ることが出来ます。

次ページ以降に各種コマンドのチュートリアル、コマンドリファレンスに各種コマンドの使用方法が説明されています。

home |index |previous |next |contents

since 04/Oct/2004

章節	表記法の例
chapter	1.
section	1.1.
subsection	1.1.1.
subsubsection	1.1.1.1.