内容

名称

Pod::Simple::RTF -- 将 Pod 格式化为 RTF

概要

perl -MPod::Simple::RTF -e \
 "exit Pod::Simple::RTF->filter(shift)->any_errata_seen" \
 thingy.pod > thingy.rtf

描述

此类是一个格式化程序,它接受 Pod 并将其呈现为 RTF,适合在 MSWord、WordPad/write.exe、TextEdit 等中查看/打印。

这是 Pod::Simple 的子类,并继承了它的所有方法。

格式控制属性

您可以在解析器对象上调用 parse_file(或类似方法)之前设置这些属性。

$parser->head1_halfpoint_size( halfpoint_integer );
$parser->head2_halfpoint_size( halfpoint_integer );
$parser->head3_halfpoint_size( halfpoint_integer );
$parser->head4_halfpoint_size( halfpoint_integer );

这些方法设置这些标题级别将以(半点,如 52 代表 26 点)显示的大小。

$parser->codeblock_halfpoint_size( halfpoint_integer );

此方法设置代码块(“逐字节段”)将以(半点,如 21 代表 10.5 点)显示的大小。

$parser->header_halfpoint_size( halfpoint_integer );

此方法设置每页页眉将以(半点,如 15 代表 7.5 点)显示的大小。页眉通常只是“modulename p. pagenumber”。

$parser->normal_halfpoint_size( halfpoint_integer );

此方法设置普通段落文本将以(半点,如 26 代表 13 点)显示的大小。

$parser->no_proofing_exemptions( true_or_false );

如果不想让格式化程序尝试在所有 Perl 符号(尽可能地识别它们)上放置一个隐藏代码,并将它们标记为非英语,因此不值得进行拼写检查,则将此值设置为 true。

$parser->doc_lang( microsoft_decimal_language_code )

这将设置语言代码,以标记此文档所在的语言。默认情况下,它当前是环境变量 RTFDEFLANG 的值,如果未设置,则为值 1033(代表美式英语)。

如果要使用 RTF 进行拼写检查,或者要进行正确的连字符化,则正确设置此项非常有用。

以下是一些值得注意的值

1033  US English
2057  UK English
3081  Australia English
4105  Canada English
1034  Spain Spanish
2058  Mexico Spanish
1031  Germany German
1036  France French
3084  Canada French
1035  Finnish
1044  Norwegian (Bokmal)
2068  Norwegian (Nynorsk)

如果您特别有兴趣进一步自定义此模块的输出,请查看源代码或与我联系。

另请参阅

Pod::SimpleRTF::WriterRTF::CookbookRTF::DocumentRTF::Generator

支持

有关 POD 和 Pod::Simple 的问题或讨论应发送到 [email protected] 邮件列表。发送一封空邮件到 [email protected] 以订阅。

此模块在开放的 GitHub 存储库中进行管理,https://github.com/perl-pod/pod-simple/。欢迎您随意分叉并贡献,或克隆 git://github.com/perl-pod/pod-simple.git 并发送补丁!

欢迎您针对 Pod::Simple 发送补丁。请将错误报告发送到 <[email protected]>。

版权和免责声明

版权所有 (c) 2002 Sean M. Burke。

本库是自由软件;您可以在 Perl 本身相同的条款下重新发布和/或修改它。

本程序按“原样”提供,不提供任何形式的担保,包括但不限于对适销性和特定用途适用性的默示担保。

作者

Pod::Simple 由 Sean M. Burke <[email protected]> 创建。但不要打扰他,他已经退休了。

Pod::Simple 由以下人员维护: