Pod::Html

(原始碼, CPAN)

版本 1.34

#名稱

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

顯示使用訊息。

#htmldir

--htmldir=name

設定所有結果 HTML 檔案中交叉參照的相對目錄。如果不傳遞此參數，所有連結都會是絕對連結，因為這是告訴 Pod::Html 說明文件樹根目錄的值。

不要在呼叫 pod2html 時同時使用此參數和 --htmlroot；它們是互斥的。

#htmlroot

--htmlroot=name

設定 HTML 檔案的基本 URL。建立交叉參照時，HTML 根目錄會加到 URL 前面。

如果需要相對連結，請不要使用此參數：請改用 --htmldir。

不要同時傳遞此參數和 --htmldir 給 pod2html；它們是互斥的。

#索引

--index
--noindex

在 HTML 檔案的頂端產生索引。這是預設行為。

#輸入檔案

--infile=name

指定要轉換的 pod 檔案。如果未指定輸入檔案，則從 STDIN 讀取輸入。

#輸出檔案

--outfile=name

指定要建立的 HTML 檔案。如果未指定輸出檔案，則輸出到 STDOUT。

#poderrors

--poderrors
--nopoderrors

如果輸入檔案中有任何 POD 錯誤，則在輸出檔案中加入「POD 錯誤」區段。此區段預設會加入。

#podpath

--podpath=name:...:name

指定 podroot 的哪些子目錄包含 pod 檔案，其 HTML 轉換後的格式可以在交叉參照中連結。

#podroot

--podroot=name

指定尋找函式庫 pod 的基本目錄。預設為目前的工作目錄。

#安靜

--quiet
--noquiet

不要顯示幾乎無害的警告訊息。這些訊息預設會顯示。但這與詳細模式不同。

#遞迴

--recurse
--norecurse

遞迴進入 podpath 中指定的子目錄（預設行為）。

#標題

--title=title

指定結果 HTML 檔案的標題。

#詳細

--verbose
--noverbose

顯示進度訊息。預設不會顯示這些訊息。

#先前匯出的輔助函式

在 perl-5.36 之前，Pod::Html 會預設或應要求匯出以下三個函式

htmlify()（預設）
anchorify()（應要求）
relativize_url()（應要求）

這些函式的定義和說明文件已移至 Pod::Html::Util，可透過 perldoc Pod::Html::Util 檢視。

從 perl-5.38 開始，這些函式必須從 Pod::Html::Util 明確匯入。請視需要修改您的程式碼。

#環境

使用 $Config{pod2html} 設定預設選項。

#作者

Marc Green，<marcgreen@cpan.org>。

原始版本由 Tom Christiansen，<tchrist@perl.com> 編寫。

#另請參閱

perlpod

#版權

此程式以 Artistic License 授權。