MakeWeb 2.0

結城 浩

[MakeWeb]
MakeWeb Version 2.0
Copyright (C) 1996,1997,1998 by Hiroshi Yuki.
All rights reserved.
hyuki@st.rim.or.jp
http://www.st.rim.or.jp/~hyuki/



1. 概要目次

1. 概要目次
2. 詳細目次
3. はじめに
4. 主な機能
5. 入手方法とインストール
6. サンプル
7. コマンド一覧
8. 作成履歴
9. 使用・変更・配付上の注意
10. 謝辞
11. 関連リンク集
12. バグ報告など



2. 詳細目次

1. 概要目次
2. 詳細目次
3. はじめに
4. 主な機能
4.1. HTMLタグに変換されるコマンド
4.2. ファイルのインクルード
4.3. 組み込み変数
4.4. コメント機能
4.5. コマンドの定義
5. 入手方法とインストール
5.1. 入手方法
5.2. ファイル一覧
5.3. 動作環境
5.4. インストール手順
5.5. アンインストール手順
5.6. 起動
6. サンプル
7. コマンド一覧
7.1. コメント
7.2. リンク(1)
7.3. リンク(2)
7.4. セクション
7.5. サブセクション
7.6. 箇条書き(1)
7.7. 箇条書き(2)
7.8. 強調印字
7.9. 縦棒
7.10. 自動置換
7.11. 空行 (廃止)
7.12. 右寄せ
7.13. HTMLタグに置換されるコマンド
7.14. その他のコマンド
8. 作成履歴
9. 使用・変更・配付上の注意
10. 謝辞
11. 関連リンク集
12. バグ報告など



3. はじめに

MakeWebはテキストファイルからHTMLファイルを生成するツールです。

MakeWebは入力ファイルを読込み、 適当な変換をほどこした後、HTMLファイルを出力します。 通常、MakeWebは入力ファイルの内容をそのまま出力ファイルにコピーしますが、 MakeWebの命令(コマンド)に出会った場合には、命令に応じた処理を行います。

もともとMakeWebは、作者である結城浩が自分のホームページのメンテナンスを行うために開発したものです。 最初はC言語で作っていましたが、Version 2.0からPerl言語に移行しました。

変更や配付については、 「使用・変更・配付上の注意」 を参照してください。



4. 主な機能


4.1. HTMLタグに変換されるコマンド

MakeWebには、HTMLのタグに変換されるコマンドがあります。

短くて書きやすいMakeWebのコマンドを使って、 面倒なHTMLタグを書かずにHTMLファイルを生成することができます。


4.2. ファイルのインクルード

MakeWebの -include コマンドを使うと、 C言語の#includeのように、ファイル中に別ファイルを挿入することができます。

この機能を使うと、共通のヘッダ、フッタ、メニューバーなどを持たせるのが容易になります。 また別ファイルに自分のアドレスや住所、著作権表記などを用意してインクルードすれば、 ページ記述の手間を省くことができます。


4.3. 組み込み変数

MakeWeb には、タイトル・サブタイトル・色系列などの組み込み変数があります。

組み込み変数を設定して、 ページのデザインを容易に変更することができます。


4.4. コメント機能

MakeWeb はセミコロン(;)で始まる行はコメントとして扱われ、 その内容はHTMLファイルには一切出力されません。


4.5. コマンドの定義

MakeWeb の -define コマンドを使うと、 ユーザが自分で新たなコマンドを作成することができます。

複雑なURLをあちこちのHTMLファイルに直接埋め込むと、 後の変更が困難になる上、入力ミスやコピーミスが生じる恐れがあります。 そのURL置換されるコマンドを MakeWeb の入力ファイル上に定義しておけば、 埋め込む場所は一個所で済むようになります。



5. 入手方法とインストール


5.1. 入手方法

MakeWeb 2.0 は、結城浩のWebページ「ソフトウェアのダウンロード」から無料でダウンロードすることができます。


5.2. ファイル一覧

以下にファイル一覧を示します。 アスタリスク(*)がついているファイルはサンプルですので、自由に変更してお試し下さい。

readme.txt     READMEファイル
makeweb.pl     MakeWeb本体

sample.txt *サンプル(MakeWebの入力ファイル) sample.htm *サンプル(HTML) header.txt *サンプルヘッダファイル footer.txt *サンプルフッタファイル common.txt *サンプル定義ファイル bg.gif サンプル背景GIFファイル ball.gif サンプル「ボール」GIFファイル

mwman.txt マニュアル(MakeWebの入力ファイル) mwnotice.txt マニュアルで使用するファイル mwheader.txt マニュアル作成用ヘッダファイル mwfooter.txt マニュアル作成用フッタファイル mwcommon.txt マニュアル作成用定義ファイル mwman.htm マニュアル(HTML) makeweb.gif MakeWebロゴGIFファイル

上記のうち、 実行に必要なファイルは makeweb.pl のみです。


5.3. 動作環境

MakeWeb は以下の環境で動作確認しました。


5.4. インストール手順

MakeWebのインストールは以下の手順で行います。

(1) Perlをインストールします。
(2) MakeWeb 用のディレクトリを作り、そこにMakeWeb のファイル一式を展開します。


5.5. アンインストール手順

MakeWeb用のディレクトリ中のファイルをすべて削除してください。


5.6. 起動

MakeWeb は以下のように起動します。

perl makeweb.pl input.txt > output.htm

ここで input.txt は MakeWeb の入力ファイルであり、 output.htm は出力ファイル (HTML) です。



6. サンプル

アーカイブに含まれているHTMLファイルは、 MakeWebを使ってTXTファイルから生成したものです。

以下に生成手順を示します。

アーカイブの内容を展開後、 以下のように入力すると、 サンプルファイル sample.htm ができます。

perl makeweb.pl sample.txt > sample.htm

あなたのWebブラウザで sample.htm を開いてください。

sample.txtはheader.txt, common.txt, footer.txtファイルを利用しています。 これらのファイルは自由に変更してお試し下さい。



7. コマンド一覧

MakeWeb は入力ファイルを一行ごとに処理していきます。 ここでいう一行とは、画面上の物理的な一行ではなく、 改行までの論理的な一行です。

MakeWeb のコマンドは必ず行の先頭から開始します。


7.1. コメント

行頭にセミコロン(;)がある行は無視されます。


7.2. リンク(1)

行頭に不等号(>)がある行はリンクを表します。 その次の行にURLを書きます。例えば、

>私のホームページ
http://www.st.rim.or.jp/~hyuki/
と記述した場合、

私のホームページ

というリンクになります。


7.3. リンク(2)

(MakeWeb 2.0以降の新機能)

行頭に不等号二つ(>>)がある行は、表示される文字列がURLそのものであるリンクを表します。

>>http://www.st.rim.or.jp/~hyuki/

と記述した場合、

http://www.st.rim.or.jp/~hyuki/

というリンクになります。

memo: 入力ファイル中に -usetilde=1 と記述すると、 リンク中のチルダ(~)を自動的に %7E に変換します。


7.4. セクション

行頭にアスタリスク(*)がある行はセクションのタイトルになります。 セクションのタイトルは、コマンド -contents を使ってまとめることができます。 また、セクションの終わりには、そのページの先頭へのリンクが自動的に挿入されます。


7.5. サブセクション

行頭にマイナスとアスタリスク(-*)がある行はサブセクションのタイトルになります。 サブセクションのタイトルは、コマンド -detailcontents を使ってまとめることができます。


7.6. 箇条書き(1)

行頭にプラス(+)がある行は箇条書きとなります。 例えば、

+箇条書き
+箇条書き
+箇条書き

と書くと、

となります。


7.7. 箇条書き(2)

行頭にマイナスとスペース(- )がある行も箇条書きになります。 ただし、この行は -[ と -] の行でくくる必要があります。 例えば、

-[
- 箇条書き
- 箇条書き
- 箇条書き
-]

と書くと、

となります。


7.8. 強調印字

行頭に感嘆符(!)がある行は強調印字になります。 例えば、

!強調印字

と書くと、

強調印字

となります。


7.9. 縦棒

行頭に縦棒(|)がある行は、特殊な置換を行いません。 コマンドそのものを記述したいときに用います。 例えば、

|-define
と書くと、
-define
となります。


7.10. 自動置換

(MakeWeb 2.0以降の新機能)

行頭にマイナス縦棒(-|)がある行は、 自動的に < や > や " を &lt; や &gt; や &quot; に置換します。 タグの説明を記述したいときに用います。


7.11. 空行 (廃止)

空行は <P> に置換されます。 この置換を抑制するためには、行頭に縦棒 (|) を書きます。


7.12. 右寄せ

行頭にドルマーク($)がある行は、右寄せになります。 例えば、

$右寄せです。
と入力ファイルに書けば、

右寄せです。

となります。


7.13. HTMLタグに置換されるコマンド

以下のコマンドはHTMLタグに単純に置換されるものです。 コマンドと置換されるHTMLタグを並べて示します。

------------------
Command   HTML Tag
------------------
-[        <UL>
-]        </UL>
-(        <BLOCKQUOTE>
-)        </BLOCKQUOTE>
--(       <PRE>
--)       </PRE>
---(      <PRE><SAMP>
---)      </SAMP></PRE>
==(       <BLOCKQUOTE><PRE>
==)       </PRE></BLOCKQUOTE>
===(      <BLOCKQUOTE><PRE><SAMP>
===)      </SAMP></PRE></BLOCKQUOTE>
------------------


7.14. その他のコマンド

=>文字列
       <BLOCKQUOTE>文字列</BLOCKQUOTE> に置換されます。

-include=ファイル名
       ファイル名で指定したファイルを挿入します。
       挿入ファイルの中でさらに -include をすることもできます。

-define=新しいコマンド名
置換する行
       新しいコマンドを定義します。-define の次の行一行が置換文字列になります。
       新しいコマンドはこれ以降 -コマンド名 の形で使うことができます。

-contents
       「目次」を作成します。
       ファイル中の * で始まる行を集め、
       そこへのリンクを生成します。

-detailcontents
       「詳細目次」を作成します。
       ファイル中の * および -* で始まる行を集め、
       そこへのリンクを生成します。

-color=色系列
       色系列を指定します。色系列は以下のいずれかです。
           none
           white
           offwhite
           yellow
           ltyellow
           ltblue
           midblue
           orange
           black
           green
           blue
           violet
           gold
           plain
       設定した色系列に応じて、MakeWeb内部では、<BODY>タグの属性
       として使用できる文字列を生成します。
       <BODY> タグの中に -color と記述します。
       使用例 header.txt を参照してください。

-title=タイトル
-subtitle=サブタイトル
-author=著者
       すべて、組み込み変数です。
       イコールをつけたときには設定、つけないときは参照になります。
       ここで設定した値が直接HTMLのタイトルになったりするわけではありません。
       あくまで文字列を保持しているだけです。
       使用例 sample.txt と header.txt を参照してください。

-ball=GIFファイル名
       セクションの頭につく飾りの画像ファイルを指定します。
       イコールをつけたときには設定、つけないときは参照になります。
       使用例 sample.txt と header.txt を参照してください。

-background=GIFファイル名
       背景のGIFファイル名を指定します。
       イコールをつけたときには設定、つけないときは参照になります。
       使用例 sample.txt と header.txt を参照してください。

-name=アンカー名
       そこに以下のようなアンカーを作ります。
       <A NAME="アンカー名"></A>
<-definename>
       (MakeWeb 2.0以降の新機能)この命令は行中でもかまいません。-define で定義したdefinenameの内容に置換されます。
-usenumber=0
       (MakeWeb 2.0以降の新機能)目次を番号付きにするなら1、しないなら0を指定します。
-usetilde=0
       (MakeWeb 2.0以降の新機能)リンク中のチルダ(~)を自動的に %7E に変換するなら1、しないなら0を指定します。



8. 作成履歴




9. 使用・変更・配付上の注意

結城浩は MakeWeb 2.0 を "as is" の形で提供します。 MakeWeb 2.0 を使用することで生じた一切の損害について、 結城浩はその責任を負いません。 ユーザは自己の責任において使用してください。

MakeWeb 2.0 は商用・非商用を問わず自由に変更・配布することができます。 ただし、著作権表示を削除することはできません。 また変更した場合には、 変更した人の著作権表示を追加しなければなりません。



10. 謝辞

MakeWebのユーザに感謝します。 発表以来、数多くのユーザから献身的なテストとレポートをいただきました。 ここに深く感謝します。



11. 関連リンク集



12. バグ報告など

MakeWeb 2.0 に関するバグ報告・要望・意見などは大歓迎します。 結城浩 <hyuki@st.rim.or.jp> へお送りください。


[MakeWeb]
MakeWeb Version 2.0
Copyright (C) 1996,1997,1998 by Hiroshi Yuki.
All rights reserved.
hyuki@st.rim.or.jp
http://www.st.rim.or.jp/~hyuki/