名前
Pod::MultiLang::Html_ja - 多言語 Pod を html に変換
概要
$parser = Pod::MultiLang::Html->new(%opts);
$parser->parse_from_file($infile,$outfile);
説明
Pod::MultiLang を継承する html へのトランスレータです. Pod::MultiLang は Pod::Parser を基底としているので, 基本的な使用方法はそれにならいます.
command/verbatim/textblock では配列への蓄積のみを行いっていて, 変換処理は end_pod で行っている. (command/verbatim/textblock の 処理は Pod::MultiLang が行っている.)
Pod::MultiLang::Html では, 生成の準備(見出しのリストアップ, 索引語の生成等)を $parser->rebuild() において行い, $parser->output_html() が生成した情報から出力のみを行う という二段になっている.
xhtml 1.1 を生成してたり^^;
オプション
new の引数は以下のものがあります.
- langs
-
langs => [qw(ja en)]
Pod::MultiLang から引き継いでいるオプション. Pod::MultiLang->new() に渡されます. "new" in Pod::MultiLang を参照してください.
使用する言語を指定します. 指定されなかった言語は, mlpod 中にあっても無視されます.
- made
-
made => 'mailto:example@example.com'
<link rev="made" href="" /> に埋め込まれます.
- css
-
css => 'style/podstyle.css' <meta http-equiv="Content-Style-Type" content="text/css" /> <link rel="stylesheet" type="text/css" href="style/podstyle.css" />
html には位置は出力するファイルと指定したcssファイルとの 相対位置で埋め込まれます.
- poddir
-
poddir => [qw(html/pod html/pragma html/lib)]
リンク先の存在確認に使うディレクトリを指定します. 配列リファレンスを指定します.
- missing_poddir
-
poddir にリンク先が見つからなかったときに, それが perl ドキュメントらしかったときに代わりに リンク先に使うディレクトリを指定します.
省略時には missing_dir が使われます.
- missing_pragmadir
-
poddir にリンク先が見つからなかったときに, それが pragma ドキュメントらしかったときに代わりに リンク先に使うディレクトリを指定します.
省略時には missing_dir が使われます.
- missing_dir
-
poddir にリンク先が見つからなかったときに, 代わりにリンク先に使うディレクトリを指定します.
- in_charset
-
入力ファイルのエンコーディングを指定します. デフォルトでは utf-8 です.
- out_charset
-
出力ファイルのエンコーディングを指定します. デフォルトでは utf-8 です.
<meta content="Content-Type" value="text/html; charset=" /> にも埋め込まれます.
- default_lang
-
J<> で囲まれていない文章に対する言語を指定します.
メソッド
new
create new instance.
OVERRIDES
This module implements Pod::Parser.
- begin_pod
- end_pod
- interior_sequence
PRIVATE FUNCTIONS
- rebuild
- buildtitle
- buildhtml
- addindex
- output_html
- escapeHtml
- escapeUrl
- makelink
- makelinkanchor
- plainize
- resolveLink
- resolvePodEscape
- unescapeHtml
- verbmsg