NAME
Pod::MultiLang::Html - turn MultiLang-pod into html
SYNOPSIS
$parser
= Pod::MultiLang::Html->new(
%opts
);
$parser
->parse_from_file(
$infile
,
$outfile
);
DESCRIPTION
Pod::MultiLang::Html translates pod into html. This inherits Pod::MultiLang and it inherits Pod::Parser, usage is same as Pod::Parser.
command/verbatim/textblock methods only do push paragraphs into an array, and end_pod method do conversion. (these process is in Pod::MultiLang.)
prepare (listing up headings, setup index words, etc.) at $parser->rebuild(), and generate at $parser->output_html();
generate html is xhtml 1.1 ^^;
OPTIONS
method new takes follow arguments:
- langs
-
langs
=> [
qw(ja en)
]
inherited from Pod::MultiLang. pass to Pod::MultiLang->new(). see "new" in Pod::MultiLang.
specify languages. paragraphs which exist in mlpod document but not selected with
langs
are ignored in result. - made
-
made
=>
'mailto:example@example.com'
embed into <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"
/>
relative path between specified location and location that output file is generated.
- poddir
-
poddir
=> [
qw(html/pod html/pragma html/lib)
]
directories for existence check of file linked from pod. by array reference.
- missing_poddir
-
used when no link target found in poddir and link target seems perl core documents.
if omitted then missing_dir is used.
- missing_pragmadir
-
used when no link target found in poddir and link target seems pragma documents.
省略時には missing_dir が使われます.
- missing_dir
-
used when no link target found in poddir.
- in_charset
-
encoding for input document. default is utf-8.
- out_charset
-
encoding for output document. default is utf-8.
and embed as <meta content="Content-Type" value="text/html; charset=" /> .
- default_lang
-
language for outsize of J<> interior sequence.
METHODS
new
create new instance.
OVERRIDES
This module implements Pod::Parser.
PRIVATE FUNCTIONS
- rebuild
- buildtitle
- buildhtml
- addindex
- output_html
- escapeHtml
- escapeUrl
- makelink
- makelinkanchor
- plainize
- resolveLink
- resolvePodEscape
- unescapeHtml
- verbmsg