问题标签 [perl-pod]

假设我有这个虚拟 Perl 包test.pm：

Test::Spelling然后，我使用...从命令行运行拼写检查

...，我的函数名称env和hst被标记为拼写错误，但hst_dir被接受：

我知道我可以使用 列出自定义字典add_stopwords()，但在我看来，函数名称根本不应该进行拼写检查。

我错过了文档中的一些细则吗？

如果这是不可能的，那么处理从 UTF-8 编码的 POD 派生的手册页的最佳做法是什么？

为了在 POD 中使用 Unicode，首先要做的是使用指令

（如此处所讨论）。和工具可以正常工作pod2text并pod2html产生完美的 UTF-8 编码输出。

但是，该pod2man工具不会：

也没有perldoc。非 ASCII 字符全部被损坏或 X-ed。关于 perlbug 是否可能是**roff*中的错误，存在一些不确定的讨论。pod2man

由于我的模块专门处理 Unicode 并打算在 CPAN 上分发，因此启用 Unicode 的手册页是必须的。

我正在使用 Perl 5.14.2、perldoc 3.15 和 *roff 1.21。

当传入的参数或参数数量不正确时，如何让 perl 程序打印 POD 内容？

我使用 Dist::Zilla 和一堆插件来检查我的 pod，包括语法、链接、覆盖率等。我一直重复的一个非常烦人的 POD 错误是忘记在 ; 之后添加额外的行=headX。例如，我刚刚创建了一个带有 pod 的模块，如下所示：

当然，我去查看 CPAN 页面并意识到我搞砸了，因为整个段落都是 head2 格式：

有没有什么好的、自动化的方法来检查我没有忘记在 a =headX（或其他任何东西）和下一段之间放置空格？

是否有向脚本添加帮助功能的标准方法？最简单的方法可能是接受一个参数并打印一些文本，如果它是“-help”或其他东西。有没有人有任何关于如何做到这一点的例子？

谢谢！

在编写将导出为 HTML 的perlpod文档时，我可以在 POD 指令中嵌入生成的 HTML 文件的标题吗？

我希望能够使用命令将多个 POD 文本文件转换为 HTML pod2html，并且不想--title="My Title"在命令行上提供参数。

例如，这是一个带有 perlpod 格式的文本文件：

当我将其转换为 HTML 时， pod2html 会发出关于没有标题的警告：

在生成的 HTML 文件中，标题设置为文件名 (test.txt)：

我想找到一种在 perpod 文档中给出标题的方法，也许有这样的指令：

在 Perl 文档中，我看到文档标题设置得很好。这一切都是在 pod 文档本身没有文档标题的情况下完成的吗？

我为我正在处理的一些脚本编写了一个便利库。Getopt::Long除了提供强制性参数外，它还包含一些更简单的东西。因此，该库将许多参数添加到脚本的必需/可能的命令行参数列表中。

由于脚本还在--help标志上调用 pod2usage，我希望库以某种方式提供它提供给单个脚本的每个标志的定义，因此可以在调用 pod2usage 时呈现它。

例如，--dosomething我的库添加了一个标志，无论如何，当我运行时a.pl --help，它将包括由 提供的帮助定义a.pl，以及由库提供的定义，就像那些--dosomething可能a.pl不知道的定义一样？

有没有办法做到这一点——让一个库在运行时修改脚本的 POD？

我将Pod::Weaver与Dist::Zilla一起使用。它为我做了几件好事。它会自动添加 POD 部分 VERSION、AUTHOR、LICENSE，在我的源代码中我可以使用简单的 POD 语法，我可以编写“=method new”，它将被转换为正确的 POD。

现在我想将图像添加到 POD。为此，我需要添加一些 HTML。所以我在我的源代码中写：

然后我在 CPAN 上编写dzil release并发布模块。上传到 CPAN 后，我发现我的 HTML POD 已被 Pod::Weaver 更改，现在看起来像：

并且这个 HTML 部分已经移到了 POD 中。我希望它在 SYNOPSIS 部分之后，但不是在最后一种方法之后。

我仍然想使用 Pod::Weaver，因为它做了很多好事，但我希望将 HTML 放在 POD 的确切位置而不进行转换。

我该怎么做？

有人知道为项目标题动态增加整数的方法吗？这主要是为了避免在需要在大量步骤中间的某处添加/删除新步骤时必须更改每个步骤编号。下面是一个小三步过程，让您大致了解模板结构：

忽略项目名称和结构，目标是尝试消除对每个项目的标题进行静态编号的使用。我想知道是否有一种可能的方法来生成一个递增的整数；很像用类似的东西替换 1、2、3 等{ print $i++ }。但是在 POD 中。

我有一个小的 perl 模块，并且正在使用 Getopt::Long，我想我不妨使用 Pod::Usage 来获得一个漂亮的帮助显示。

经过一番摆弄，我让它工作得相当好，只有一个小例外。我无法设置输出的宽度。

我的终端有 191 个字符宽。使用 perldoc Module.pm，它将文档正确格式化为该宽度。使用 pod2usage()，它使用 76 个字符的默认宽度。

我不知道如何将宽度选项传递给格式化程序。该文档显示了如何使用 BEGIN 块设置不同的格式化程序（例如 Pod::Text::Termcap），并且我使用 Term::ReadKey 来拉宽度（已验证），但我无法让格式化程序看见。

有什么提示吗？

这是我要测试的完整模块，以及一个用于加载它的小测试脚本。要明白我的意思，打开一个具有合理宽度的终端（132 或更大，所以很明显），并将“./test.pl --man”的输出与“perldoc MUD::Config”的输出进行比较.

我可以不用 perldoc 添加的手册页样式页眉和页脚，但我希望它尊重（并使用）终端宽度。

测试.pl

和 MUD/Config.pm