目录

名称

Pod::Text::Overstrike - 将 POD 数据转换为格式化的删除线文本

语法

use Pod::Text::Overstrike;
my $parser = Pod::Text::Overstrike->new (sentence => 0, width => 78);

# Read POD from STDIN and write to STDOUT.
$parser->parse_from_filehandle;

# Read POD from file.pod and write to file.txt.
$parser->parse_from_file ('file.pod', 'file.txt');

说明

Pod::Text::Overstrike 是 Pod::Text 的一个简单子类,它使用删除线序列突出显示输出文本,类似于 nroff。粗体文本中的字符被删除线(字符、退格、字符),下划线文本中的字符被转换为删除线下的下划线(下划线、退格、字符)。此格式最初是为硬拷贝终端和/或行式打印机设计的,但可以在软拷贝(CRT)终端上读取。

删除线文本最好通过逐页程序查看,该程序利用终端的突出显示下划线功能,例如 Unix 上的 less 程序。

除了删除线之外,它在所有方面都像 Pod::Text 一样工作。有关详细信息和可用选项,请参阅 Pod::Text

错误

目前,最外层的格式化指令获胜,例如,粗体文本区域内的下划线文本仅显示为粗体。可能有一些更好的方法。

兼容性

Pod::Text::Overstrike 1.01(基于 Pod::Parser)是 Perl 5.6.1 中包含此模块的第一个版本。

基于 Pod::Simple 的当前 API 已添加到 Pod::Text::Overstrike 2.00 中,并包含在 Perl 5.9.3 中。

最近在 Pod::Text::Overstrike 2.04 中修复了换行和行长的几个问题,并包含在 Perl 5.11.5 中。

此模块继承了 Pod::Text 的 API 和大多数行为,因此 Pod::Text 中的“COMPATIBILITY” 中的详细信息也适用。自 4.00(包含在 Perl 5.23.7 中)以来,Pod::Text 和 Pod::Text::Overstrike 具有相同的模块版本。(不幸的是,在此之前它们以令人困惑的方式分歧。)

作者

最初由 Joe Smith <[email protected]> 编写,使用 Russ Allbery <[email protected]> 创建的框架。随后由 Russ Allbery 更新。

版权和许可证

版权所有 2000 年 Joe Smith <[email protected]>

版权所有 2001 年、2004 年、2008 年、2014 年、2018-2019 年、2022 年 Russ Allbery <[email protected]>

此程序是免费软件;您可以在与 Perl 自身相同的条款下重新分发和/或修改它。

另请参阅

Pod::TextPod::Simple

此模块的当前版本始终可从其网站 https://www.eyrie.org/~eagle/software/podlators/ 获取。它也是 Perl 5.6.0 及更高版本的 Perl 核心发行版的一部分。