Pod::Html

(源代码, CPAN)

版本 1.34

内容

名称
概要
描述
函数
- pod2html
- 以前导出的辅助函数
环境
作者
另请参阅
版权

#名称

Pod::Html - 将 pod 文件转换为 HTML 的模块

#概要

use Pod::Html;
pod2html([options]);

#描述

将 pod 格式（参见 perlpod）的文件转换为 HTML 格式。它可以自动生成索引和交叉引用，并保留它知道如何交叉引用的内容的缓存。

#函数

#pod2html

pod2html("pod2html",
         "--podpath=lib:ext:pod:vms",
         "--podroot=/usr/src/perl",
         "--htmlroot=/perl/nmanual",
         "--recurse",
         "--infile=foo.pod",
         "--outfile=/perl/nmanual/foo.html");

pod2html 采用以下参数

#backlink

--backlink

将每个 head1 标题变成一个返回页面顶部的链接。默认情况下，不生成回链。

#cachedir

--cachedir=name

#css

--css=stylesheet

指定层叠样式表的 URL。还会禁用默认情况下输出的所有 HTML/CSS style 属性（以避免冲突）。

#flush

--flush

刷新目录缓存。

#header

--header
--noheader

创建包含NAME部分文本的页眉和页脚块。默认情况下，不生成页眉。

#help

--help

显示用法信息。

#htmldir

--htmldir=name

设置生成 HTML 文件中所有交叉引用的相对目录。不传递此项将导致所有链接为绝对链接，因为这是告知 Pod::Html 文档树根目录的值。

不要在对 pod2html 的同一调用中使用此项和 --htmlroot；它们互斥。

#htmlroot

--htmlroot=name

设置 HTML 文件的基准 URL。当进行交叉引用时，HTML 根目录将添加到 URL 前缀。

如果需要相对链接，请不要使用此项：改用 --htmldir。

不要同时将此项和 --htmldir 传递给 pod2html；它们互斥。

#index

--index
--noindex

在 HTML 文件顶部生成索引。这是默认行为。

#infile

--infile=name

指定要转换的 pod 文件。如果没有指定 infile，则从 STDIN 获取输入。

#outfile

--outfile=name

指定要创建的 HTML 文件。如果没有指定 outfile，则输出到 STDOUT。

#poderrors

--poderrors
--nopoderrors

如果 infile 中有任何 POD 错误，则在 outfile 中包含“POD ERRORS”部分。默认情况下包含此部分。

#podpath

--podpath=name:...:name

指定 podroot 的哪些子目录包含 pod 文件，其 HTML 转换形式可以在交叉引用中链接到。

#podroot

--podroot=name

指定查找库 pod 的基准目录。默认值为当前工作目录。

#quiet

--quiet
--noquiet

不显示几乎无害的警告消息。默认情况下会显示这些消息。但这与verbose模式不同。

#recurse

--recurse
--norecurse

递归到 podpath 中指定的子目录（默认行为）。

#title

--title=title

指定生成 HTML 文件的标题。

#verbose

--verbose
--noverbose

显示进度消息。默认情况下，不会显示这些消息。

#以前导出的辅助函数

在 perl-5.36 之前，Pod::Html 导出了以下三个函数，默认或应要求导出

htmlify()（默认情况下）
anchorify()（应要求）
relativize_url()（应要求）

这些函数的定义和文档已移至 Pod::Html::Util，可通过 perldoc Pod::Html::Util 查看。

从 perl-5.38 开始，必须从 Pod::Html::Util 中显式导入这些函数。请根据需要修改代码。

#ENVIRONMENT

使用 $Config{pod2html} 设置默认选项。

#AUTHOR

Marc Green，<[email protected]>。

原始版本由 Tom Christiansen（）编写。

#另请参阅

perlpod

#版权

此程序在 Artistic License 下分发。