pod.html

来自「perl教程」· HTML 代码 · 共 141 行

HTML
141 行
字号 
<?xml version="1.0" ?>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<!-- saved from url=(0017)http://localhost/ -->
<script language="JavaScript" src="../../../displayToc.js"></script>
<script language="JavaScript" src="../../../tocParas.js"></script>
<script language="JavaScript" src="../../../tocTab.js"></script>
<link rel="stylesheet" type="text/css" href="../../../scineplex.css">
<title>ActivePerl::DocTools::Pod - Functions to process POD for ActivePerl</title>
<link rel="stylesheet" href="../../../Active.css" type="text/css" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:" />
</head>

<body>

<script>writelinks('__top__',3);</script>
<h1><a>ActivePerl::DocTools::Pod - Functions to process POD for ActivePerl</a></h1>
<p><a name="__index__"></a></p>

<!-- INDEX BEGIN -->

<ul>

	<li><a href="#name">NAME</a></li>
	<li><a href="#description">DESCRIPTION</a></li>
	<li><a href="#see_also">SEE ALSO</a></li>
	<li><a href="#bugs">BUGS</a></li>
</ul>
<!-- INDEX END -->

<hr />
<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>ActivePerl::DocTools::Pod - Functions to process POD for ActivePerl</p>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p>The following functions are provided:</p>
<dl>
<dt><strong><a name="item_pod2html">pod2html( %args )</a></strong>

<dd>
<p>Convert a POD document into an HTML document.  This is a wrapper for
the <a href="#item_pod2html"><code>pod2html()</code></a> function of <code>Pod::Html</code> that also modify the document
produced with various ActivePerl enhancements.</p>
</dd>
<dd>
<p>The following arguments are recognized:</p>
</dd>
<dl>
<dt><strong><a name="item_infile__3d_3e__24filename">infile =&gt; $filename</a></strong>

<dd>
<p>The name of the POD file you want to convert.  This argument is mandatory.</p>
</dd>
</li>
<dt><strong><a name="item_outfile__3d_3e__24filename">outfile =&gt; $filename</a></strong>

<dd>
<p>The name of the HTML file you want as output.  This argument is mandatory.</p>
</dd>
</li>
<dt><strong><a name="item_depth__3d_3e__24int">depth =&gt; $int</a></strong>

<dd>
<p>How many directory levels down from the root of the HTML tree will the
generated file eventually be installed.  The root of the HTML tree is
normally found at $Config{installhtmldir}, which is normally
&quot;$Config{prefix}/html&quot;.</p>
</dd>
<dd>
<p>The default is 0.</p>
</dd>
</li>
<dt><strong><a name="item_podroot__3d_3e__24dirname">podroot =&gt; $dirname</a></strong>

<dd>
<p>Specify the base directory for finding library pods.
The default is $Config{prefix}.</p>
</dd>
</li>
<dt><strong><a name="item_podpath__3d_3e__5b_24dir1_2c__24dir2_2c_2e_2e_2e_5">podpath =&gt; [$dir1, $dir2,...]</a></strong>

<dd>
<p>What subdirectories of the <code>podroot</code> should be searched for POD files
in order to discover targets for links from the generated HTML file.
The specified directories must all exist.</p>
</dd>
<dd>
<p>The links are generated with the assumption that the discovered POD
files are converted into HTML files with and <em>.html</em> extension and
placed into an hierarchy (the HTML tree rooted at
$Config{installhtmldir}) using the same layout as the one found under
<code>podroot</code>.</p>
</dd>
<dd>
<p>Instead of passing an array reference, the directories can
alternatively be specified as a single string of directory names
separated by <code>:</code>.</p>
</dd>
<dd>
<p>The default is <code>[qw(bin lib)]</code>.</p>
</dd>
</li>
<dt><strong><a name="item_index__3d_3e__24bool">index =&gt; $bool</a></strong>

<dd>
<p>Should a table on contents be created at the start of the HTML
document.  By default no table of contents is generated.</p>
</dd>
</li>
</dl>
<dt><strong><a name="item_pod2html_remove_cache_files">pod2html_remove_cache_files( )</a></strong>

<dd>
<p>The <a href="#item_pod2html"><code>pod2html()</code></a> will create cache files with names starting with
<em>pod2htm</em> in the current directory.  These cache files allow pod2html
to save link state between runs.  Call this function to clean up these
cache files.</p>
</dd>
</li>
</dl>
<p>
</p>
<hr />
<h1><a name="see_also">SEE ALSO</a></h1>
<p><a href="../../../lib/Pod/Html.html">the Pod::Html manpage</a></p>
<p>
</p>
<hr />
<h1><a name="bugs">BUGS</a></h1>
<p>none.</p>

</body>

</html>

pod.html - 源码说明

本页面展示了「perl教程」中的 pod.html 源码文件，采用 HTML 编程语言编写，共 141 行代码。您可以在线阅读完整代码内容，也可以返回资源详情页下载完整源码包进行本地学习和开发。

虫虫开发者社区收录了大量与Perl相关的技术资源，包括源代码、技术文档、电路图等，是电子工程师和嵌入式开发者的专业学习平台。

⌨️ 快捷键说明

复制代码Ctrl + C
搜索代码Ctrl + F
全屏模式F11
增大字号Ctrl + =
减小字号Ctrl + -
显示快捷键?