「Plain Old Documentation」の版間の差分
「POD文書例」と「外部リンク」を大幅メンテ |
m ロボットによる: HTML転換 |
||
94行目: | 94行目: | ||
<p> |
<p> |
||
</p> |
</p> |
||
---- |
|||
<hr /> |
|||
<div style="font-size:188%; padding-top: .5em; padding-bottom:.17em;">概要</div> |
<div style="font-size:188%; padding-top: .5em; padding-bottom:.17em;">概要</div> |
||
<nowiki> $here->isa(Piece::Of::Code);</nowiki><br /> |
<nowiki> $here->isa(Piece::Of::Code);</nowiki><br /> |
||
104行目: | 104行目: | ||
<p> |
<p> |
||
</p> |
</p> |
||
---- |
|||
<hr /> |
|||
<div style="font-size:188%; padding-top: .5em; padding-bottom:.17em;">記述</div> |
<div style="font-size:188%; padding-top: .5em; padding-bottom:.17em;">記述</div> |
||
<p>これは標準テキストです。これは |
<p>これは標準テキストです。これは'''ボールド'''、 |
||
|
''イタリック''、<ins>アンダーライン</ins>、<code>リテラルコード</code>の |
||
テキスト書式を内部に含んでいます。</p> |
テキスト書式を内部に含んでいます。</p> |
||
<p> |
<p> |
||
113行目: | 113行目: | ||
<div style="font-size:150%; font-weight:bold; padding-top: .5em; padding-bottom:.17em;">例の一覧</div> |
<div style="font-size:150%; font-weight:bold; padding-top: .5em; padding-bottom:.17em;">例の一覧</div> |
||
<ul> |
<ul> |
||
<li> |
<li>'''これは正丸リストです。''' |
||
<li> |
<li>'''ここに別口があります。''' |
||
</ul> |
</ul> |
||
[[Image:Example.png|範例|right|thumb]] |
[[Image:Example.png|範例|right|thumb]] |
||
125行目: | 125行目: | ||
</p><p> |
</p><p> |
||
</p> |
</p> |
||
---- |
|||
<hr /> |
|||
<div style="font-size:188%; padding-top: .5em; padding-bottom:.17em;">参照</div> |
<div style="font-size:188%; padding-top: .5em; padding-bottom:.17em;">参照</div> |
||
<p> |
<p>''perlpod'', ''perldoc'', [[/Pod/Parser|the Pod::Parser manpage]].</p> |
||
<p> |
<p> |
||
</p> |
</p> |
||
---- |
|||
<hr /> |
|||
<div style="font-size:188%; padding-top: .5em; padding-bottom:.17em;">著作権</div> |
<div style="font-size:188%; padding-top: .5em; padding-bottom:.17em;">著作権</div> |
||
<p>Copyright 2005 J. Random Hacker <[mailto:jrh@cpan.org jrh@cpan.org]>.</p> |
<p>Copyright 2005 J. Random Hacker <[mailto:jrh@cpan.org jrh@cpan.org]>.</p> |
2008年6月15日 (日) 09:13時点における版
特徴
POD は必要十分な文法を持つ単純で明快な言語として設計された。書体、画像、色、表などの機構を意図的に排除し、必要な機能だけを持つようにしている。その目的は以下の通りである。 ●構文解析が簡単である。 ●他の言語︵HTML や TeX︶への変換が簡単である。 ●サンプルコードを含めるのが簡単である。 ●フォーマッタで整形しなくても︵ソースコードのままで︶読むのが簡単である。 ●書くのが簡単である。さもなくばプログラマは文書を書きたがらない。 perlpod の筆者は﹁POD形式は本を書くのには不十分である﹂と書いているが、PODを拡張した書式で本が実際に書かれている。この拡張版PODには表や脚注の機能があり、オライリーメディアから出ているいくつかのPerlに関する本で使われた。例えば、ラリー・ウォール、ジョン・オーワント、トム・クリスチャンセンの Programming Perl︵邦題は﹃プログラミング Perl﹄︶が有名である。POD を若干拡張修正した版として MOD があり、Mark Jason Dominus による Higher-Order Perl で使われた。利用
POD は Perl 関連での文書作成に使われている。Perl 自身、ほとんど全ての公開されている Perl モジュール、多くのスクリプト言語、多くの設計文書、Perl.com などの Perl 関連 Webサイトにある多くの記事、Parrot仮想機械などで使われている。 POD形式のソースコードをそのまま読むことは少ないが、そのままでも読めるように設計されている。一般に、perldoc ツールを使って読んだり、UNIXマニュアル形式に変換したり、HTML形式に変換したりする。 純粋な POD ファイルの拡張子は.pod
だが、POD は通常 Perl のソースコードに埋め込んで使われるため、拡張子は .
pl
または .pm
であることが多い。Perl インタプリタの構文解析器はソースコード内の POD 部分を無視するよう設計されている。
POD文書例
これは文法的に正しい POD であり、節の題名についても規約に従っている。POD文書ソース | HTML変換結果[1] |
---|---|
=head1 名前 podsample - POD文書のサンプル =head1 概要 $here->isa(Piece::Of::Code); print <<"END"; このインデントされたブロックはフォーマットされた コードか指示のため、走査されずに、スペースは保持 されるでしょう。 END =head1 記述 これは標準テキストです。これはB<ボールド>、I<イタリック>、 U<アンダーライン>、C<$リテラルコード>のテキスト書式を 内部に含んでいます。 =head2 例の一覧 =over 4 =item * これは正丸リストです。 =item * ここに別口があります。 =back =begin html <img src="Example.png" align="right" alt="範例" /> <p> ここに、何らかの埋め込まれたHTMLがあります。 このブロックでは、画像を入れたり、 <span style="color: green">スタイル</span>を 適用するか、HTMLで記述しています。PODパーサは HTML出力中にそれを完全に無視することはありません。 </p> =end html =head1 参照 L<perlpod>, L<perldoc>, L<Pod::Parser>. =head1 著作権 Copyright 2005 J. Random Hacker <jrh@cpan.org>. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. =cut
|
名前
podsample - POD文書のサンプル
リテラルコード の
テキスト書式を内部に含んでいます。
例の一覧
●これは正丸リストです。
●ここに別口があります。
![]() |
<h1><span id="name">名前</span></h1> <p>podsample - POD文書のサンプル</p> <p> </p> <hr /> <h1><span id="synopsis">概要</span></h1> <pre> $here->isa(Piece::Of::Code); print <<"END"; このインデントされたブロックはフォーマットされた コードか指示のため、走査されずに、スペースは保持 されるでしょう。 END</pre> <p> </p> <hr /> <h1><span id="description">記述</span></h1> <p>これは標準テキストです。これは<strong>ボールド</strong>、 <em>イタリック</em>、<ins>アンダーライン</ins>、<code>リテラルコード</code>の テキスト書式を内部に含んでいます。</p> <p> </p> <h2><span id="an_example_list">例の一覧</span></h2> <ul> <li><strong><span id="item_this_is_a_bulleted_list_2e">これは正丸リストです。</span></strong> <li><strong><span id="item_here_27s_another_item_2e">ここに別口があります。</span></strong> </ul> [[Image:Example.png|範例|right|thumb]] <p> ここに、何らかの埋め込まれたHTMLがあります。 このブロックでは、画像を入れたり、 <span style="color: green">スタイル</span>を 適用するか、HTMLで記述しています。PODパーサは HTML出力中にそれを完全に無視することはありません。 </p><p> </p> <hr /> <h1><span id="see_also">参照</span></h1> <p><em>perlpod</em>, <em>perldoc</em>, <a href="/Pod/Parser.html">the Pod::Parser manpage</a> <p> </p> <hr /> <h1><span id="copyright">著作権</span></h1> <p>Copyright 2005 J. Random Hacker <jrh@cpan.org>.</p> <p>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts.</p> |
POD における書式の詳細
B<bolded t
ext>
となる。
●1文字の大文字の後に2つ以上の不等号(<<)が続き、その後に整形すべき内容、さらにその後に同じ個数の不等号(>>)が続く。例えば、B<< bolded text >>
となる。これは内容に不等号が含まれる場合に使われる。
POD 内のコマンド︵ディレクティブ︶には、4段階の節、番号なしと番号つきのリスト、他の言語の節などがある。他の言語の節は、その言語を解釈する構文解析器による特殊な整形を可能にする。