|
简介pod(Plain Old Documentation), 是一种简单而易用的标记型语言（置标语言），它经常用于在perl程序和模块中的文档书写。
在pod中，用段类型可分为三种，普通段落，字面段落（Verbatim Paragraph）和命令段落。
三者的区分非常简单，以=pod|head1|cut|over等指示字开始的段落为命令段落，以空格或制表符（\t）等缩进字符开始的段落为字面段落，其余的就是普通段落。
pod中有其独特的格式代码来表现粗体，斜体，超链接等。
在pod中，对于字面段落的文本，是从来都不进行格式代码转义的。pod2html时用<pre >将其包围。所以字面段落非常适合在引用语言与代码块时运用。
当然，值得注意的是，对于pod2xxx脚本来说，段落意味着前后各有一个空行。
下面我们要介绍的pod，都是用于pod2html这项功能的。
命令指示字=head1
=head2
=head3
=head4
上面的四个指示字产生指定级别的标题。在pod2html时，用他们各自对应的
.. 来包围此段落，并且自动生成a的命名/name和索引/index.
一个简单的例子： =head1 NAME
pod2html - convert .pod files to .html files
pod2html后NAME的标签为h1, 而后面的那段为p。
=pod
=cut
=pod 只告诉编译器pod文档开始了，而=cut则是pod文档的结束。
一个简单的例子： return;
}
=pod
Here we start our pod
=cut
sub _ {
=over NUMBER
=item SYMBOL
=back
上面三个标签是连在一起的。=over后面必须要跟一个=back，而这两者之间最少要有一个=item，同时不能有=head1至head4。
pod2html时依据item后面的SYMBOL不同将其转化为<dl><ol><ul>中的一种。
当SYMBOL为数字时使用ol, SYBMOL为*时使用ul, 其余的使用dl.
而=over后面的NUMBER只是用来确定缩进中的空格。不同的格式器(pod2xxxx)对于NUMBER有着不同地处理，另外有些格式器对此则进行忽略。默认的NUMBER为4。
=item 能自动生成a的命名，但不参加索引/index（与head不同）。
一个简单的例子： =over 4
=item L<http://www.perl.com/>
Perl 的首页 (由欧莱礼公司维护)
=item L<http://www.cpan.org/>
Perl 综合典藏网 (Comprehensive Perl Archive Network)
=item L<http://lists.perl.org/>
Perl 邮递论坛一览
=back
此例子摘自perlcn.pod
=for format text =begin format =end format 此指示字的作用是对此段落使用特殊的格式/format（如html, text等）。 =for与=begin+=end作用相同。区别在于=for只处理一个段落，而=begin+=end却能处理它们中间的多个段落。 format为html时，可以用于增加“命令指示字和格式代码”都不能实现的特殊格式。如<img或其它html标签。
一个简单的例子： =begin html
<hr> <img src="thang.png">
<p> This is a raw HTML paragraph </p>
=end html
pod2html时会原文拷贝此段代码。
=encoding
用于制定文档的编码，默认为不指定。
[1] [2] 下一页 |
