htmlgen.pl Manual Page

目次 ^†

目次
概要
機能
更新履歴
ダウンロード
使い方
オプション
文法一覧
例
テスト
備考
注意
奥付

概要 ^†

HTMLページをWikiライクなソースコードから生成するためのPerlスクリプトです。

Wikiは（キャッシュがあるとは言え）動的にページを生成しており、パフォーマンス上の問題があります。また、生成されたページが全て同じスタイル・スキンで管理されるので、統一性はありますが、ページごとに異なったスタイルを用いるなどの小回りが利きません。更に、複数人で編集する必要がない「ちょっと相手に文書を見せる」ような用途にもWikiは大きすぎます。かと言って.pdfや.docは専用のソフトがないと見られず、手軽さの面でHTMLには劣ってしまいます。

blogは、日記のような連続した、かつページ間での関連性が薄いコンテンツを数多く掲載するためには非常に強力なツールになりますが、一方で「あるテーマに的を絞ったページ群」^*1 を作ろうとすると、「カテゴリ」のような機能ではどうしても力不足で、一覧性も良くないため他のコンテンツに埋没してしまいがちです。

そこで、単体で独立したHTMLページを生成するプログラムの必要性を感じ、このhtmlgen.plを作成しました。似たようなものは探せば絶対に存在するはずですが、

文法などが好みに合わせられる
他の人が作ったものを改造するよりも、自分で1から作った方が勉強になるし融通も利く
そもそも探すのが面倒くさかった（死

…という理由で製作することにしました。

Wikiや各種blogツールよりはTeXが近いと思います。勿論TeXでもHTMLを出力することは可能なはずですが、論文のような文書よりはHTML寄りに作られたものの方が、何かと役に立つ部分があるのではないかと。

スタティックなHTMLを生成しますので、Wikiやblogと比べると、サーバーへの負担が減ります。同時にロード時間も短縮されるので「軽い」ページを製作したい方にお勧めです。

当然ですが、ディレクトリ構成も全て自分でやることができますので、blogのように見通しが悪くなることがありません。

機能 ^†

生成されたページはXHTML 1.1標準に準拠^*2
列方向の連結やcolgroupのサポートなど、多彩なtable機能。
必要十分な文字飾り。
文法を拡張することなく任意のタグを記述できる naked { ... } ブロック。
リスト（ulなど）の深さ制限など、本質的ではないスクリプトによる文法の制限の排除。
人間にも読みやすいソースを出力。

更新履歴 ^†

2007/08/04
- ver. 0.01
  - first version
- ver. 0.02
  - [Chg] refactored source
  - [Add] naked block
  - [Add] source comment
  - [Add] #now, #created, #modified, #span
2007/08/05
- ver. 0.03
  - [Chg] Escape ' by ' or '
  - [Chg] Make link beside headers
  - [Add] #contents index generator
  - [Add] #include directive
  - [Add] Multiple Ruby
  - [Fix] Character escape method
  - [Fix] Multiple thead/tfoot in a table
  - [Fix] Backward unescape failure
2007/08/06
- ver. 0.04
  - [Fix] Some minor bugs
  - [Add] meta Author, Description, keywords
- ver. 0.05
  - [Add] $$ inline element for <br />
2007/08/14
- ver. 0.06
  - [Fix] Quoted values in parameters.
  - [Fix] Character escape bug.
  - [Fix] Table column splitting.
- ver. 0.07
  - [Fix] #include endmark bug.
  - [Fix] Link parsing.
- ver. 0.08
  - [Fix] Comment processing
  - [Chg] Refactored Table Parsing Algorithm
  - [Add] Auto-Link
- ver. 0.09
  - [Fix] Link Making Algorithm
  - [Chg] Link Syntax [] -> [[]]
2007/08/15
- ver. 0.10
  - [Add/Chg] meta header contents
  - [Add] --nofooter option
  - [Add] pragma document keyword
2007/08/16
- ver. 0.11
  - [Add] block id support
  - [Add] <address> support
2007/08/21
- ver. 0.12
  - [Fix] Auto-link in the beginning of buffer.
  - [Chg] Content-Type MIME text/html -> application/xhtml+xml
2007/09/04
- ver. 0.13
  - [Fix] <pre> tag front/rear space
2007/09/28
- ver. 0.14
  - [Fix] Links in footnotes.
2007/10/24
- ver. 0.15
  - [Fix] Removed <pre> tag post tabs.
  - [Add] Add #id in colgroup
  - [Add] --notopinex option. It prevents the top level header (h1) to be added to #contents;
2007/11/03
- ver. 0.16
  - [Fix] Change footer text.
2007/11/04
- ver. 0.17
  - [Fix] Comments in >|| ... ||<
2007/11/10
- ver. 0.18
  - [Fix] Removed indent tabs in naked or ascii_art block.
2007/11/11
- ver. 0.19
  - [Fix] Escaped | in thead, tfoot.
  - [Fix] Add <br /> in ascii_art.
  - [Fix] Special character in headers.
2007/11/17
- ver. 0.20
  - [Add] --output(-o) option. place pragma.
  - [Chg] Default values of title, charset and language.
2007/12/19
- ver. 0.21
  - [Add] --template, --template_css option.
2008/01/29
- ver. 0.22
  - [Fix] Removed #include garbages in <pre>.
  - [Chg] Refactored.
  - [Fix] Some minor bugs.
2008/02/03
- ver. 0.23
  - [Add] Add [class] spec for table column.
  - [Add] Block style <dl>.
  - [Chg] Refactored.
2008/03/09
- ver. 0.24
  - [Add] CSS embedding.
2009/03/06
- ver. 0.25
  - [Fix] --template and --template_css didn't work well.

ダウンロード ^†

最新バージョンはこちらです。

使い方 ^†

Windowsなら「コマンドプロンプト」で

perl htmlgen.pl [options] <source file> > <output file>

または

perl htmlgen.pl [options] < <source file> > <output file>

とすると、<source file>から生成されたHTMLが<output file>に出力されます。

LinuxなどのOSを使っている方には特に説明する必要はないでしょう。

オプション ^†

指定できるオプションは以下の通りです。

オプション	機能
--nofooter	ページ最下部の著作権とhtmlgen.pl、XHTML Validatorの表示を削除します。
--notopindex	#contents;で作成する目次に、トップレベル(h1相当)の見出しを含めないようにします。
--template	ソースファイルのスケルトンを生成します。
--template_css	スタイルシートのスケルトンを生成します。
--output <file>	標準出力の代わりに<file>に出力します。

文法一覧 ^†

機能	構文
機能	構文
ページ全体の指定
タイトル	`title : <title>`
文字セット	`charset : <charset>`
言語	`language : <lang>`
著者	`author : <author>`
概要	`description : <description>`
キーワード	`keywords : <keyword>,<keyword>,...,<keyword>`
外部スタイルシートの利用	`stylesheet : [@]<url>, <media>`^*3
外部スクリプトの利用	`script : <script>, <mime type>`
著作権表示	`copyright : <copyright>`
スクリプトへの指示	`pragma : [option][,option]...`^*4
出力ファイル	`place : <file>`
ブロック要素
引用	`> ...`
複数行の引用	`>> ... <<`
整形済みテキスト(pre)	`>\|\| ... \|\|<`
アスキーアート^*5	`>$$ ... $$<`
定義リスト	`:<word>\|<desctiption>`
定義リスト（ブロック）	`dl {}` の中に`:<word> {...}`
順序なしリスト^*6	`- ...`
	`-- ...`
	`...`
	`--...- ...`
順序付きリスト^*7	`+ ...`
	`++ ...`
	`...`
	`++...+ ...`
見出し	`* <level 1 title>`
	`** <level 2 title>`
	`...`
	`****** <level 6 title>`
コードブロック^*8	`[<class name>][#<id>] { ... contents ... }`
HTMLタグを直接記述^*9	`naked { ... <html source> ... }`
水平線	`-----`
目次の生成	`#contents;`
ファイルの取り込み	`#include(<file>);`
Table機能
一般行	`\|abc\|def\|...\|ghi\|`
見出し行（ヘッダ）	`\|header1\|header2\|...\|headerN\|h`
見出し行（フッタ）	`\|footer1\|footer2\|...\|footerN\|t`
見出し行（中間）	`\|header1\|header2\|...\|headerN\|m`
書式指定	`\|<format1>\|<format2>\|...\|<formatN>\|f`
書式指定	format=`[(left\|right\|center)][,width=<width>][,header][,#id][,[class]]`
表題	`\|<caption>\|c`
左と連結	`<`
上と連結	`^`
インライン要素
強調(strong)	`'' ... ''`
強調(emphasis)	` ... `
斜体	`!! ... !!`
下線	`__ ... __`
打ち消し	`%% ... %%`
追加された部分^*10	`++ ... ++`
~~削除された部分~~^*11	`-- ... --`
ルビ	`^<text>(<ruby>)`
二重ルビ^*12	`^^<text>(<ruby1>,<ruby2>)`
改行	`$$`
脚注	`(( ... ))`
プログラムのソースコード	`{{ ... <code> ...` }}
リンク	`[[<link text>:<url>]]`
画像の挿入	`#img(url=<url>,alt=<alternative text>[,size=<width>x<height>][,nolink]);`
画像の挿入	nolink : 画像を画像へのリンクとしない。
生成日時	`#now;`
ソースファイルの作成日時	`#created;`
ソースファイルの更新日時	`#modified;`
タグ付け^*13	`#span(class=<class>[,id=<id>]){ ... }`
コメント	`// ...`
後続の特殊文字のエスケープ	`\`

例 ^†

例1：サンプルページ
- サンプルページとそのソースです。
例2：このページ
- このページのソースです。

テスト ^†

Perlの実行環境を入れるのが面倒だという人のために、実験ページを作りました。お試しください。

※ソースのエラーチェックは最低限です。

備考 ^†

\マークの問題があるので、ソースコードはEUCで書いた方がいいでしょう。
このページ自身もhtmlgen.plによって生成されています。

注意 ^†

バグ、使いにくい点などありましたら、簡単なサンプルを添えて私までお知らせください。できる限り対応します。
再配布は禁止します。

奥付 ^†

Author: Tomoya NAKAGAWA
Last Update: 2009/11/23 23:22:27

htmlgen.pl Manual Page †

目次 †

概要 †

機能 †

更新履歴 †

ダウンロード †

使い方 †

オプション †

文法一覧 †

例 †

テスト †

備考 †

注意 †

奥付 †

htmlgen.pl Manual Page ^†