內容

名稱

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

BUG

目前,最外層的格式化指令會獲勝,因此例如粗體文字區域內的底線文字會顯示為單純的粗體。可能有一些更好的方法。

相容性

Pod::Text::Overstrike 1.01(基於 Pod::Parser)是此模組的第一個版本,包含在 Perl 5.6.1 中的 Perl 中。

基於 Pod::Simple 的目前 API 已新增至 Pod::Text::Overstrike 2.00,包含在 Perl 5.9.3 中。

包含在 Perl 5.11.5 中的 Pod::Text::Overstrike 2.04 已修正了換行和行長的幾個問題。

此模組從 Pod::Text 繼承其 API 和大部分行為,因此 "Pod::Text 中的相容性" 中的詳細資訊也適用。自 4.00(包含在 Perl 5.23.7 中)以來,Pod::Text 和 Pod::Text::Overstrike 擁有相同的模組版本。(在之前,它們不幸地以令人困惑的方式分歧。)

作者

最初由 Joe Smith <Joe.Smith@inwap.com> 編寫,使用 Russ Allbery <rra@cpan.org> 建立的架構。隨後由 Russ Allbery 更新。

著作權和授權

著作權所有 2000 Joe Smith <Joe.Smith@inwap.com>

著作權所有 2001、2004、2008、2014、2018-2019、2022 Russ Allbery <rra@cpan.org>

此程式為免費軟體;您可以在與 Perl 本身相同的條款下重新散布或修改它。

另請參閱

Pod::TextPod::Simple

此模組的目前版本隨時可在其網站 https://www.eyrie.org/~eagle/software/podlators/ 取得。它也是 Perl 核心散布的一部分,版本為 5.6.0。