=encoding utf-8 =head1 NAME =begin original Module::Install::ReadmeMarkdownFromPod - create README.mkdn from POD =end original Module::Install::ReadmeMarkdownFromPod - PODから README.mkdnの生成 =head1 SYNOPSIS # in Makefile.PL use inc::Module::Install; name 'Some-Module'; readme_markdown_from 'lib/Some/Module.pm'; =head1 DESCRIPTION =begin original L is a L extension that generates a C file automatically from an indicated file containing POD whenever the author runs C. This file is used by GitHub to display nicely formatted information about a repository. =end original Lは Lの拡張であり, Cを実行したときに指定したファイルに含まれる PODから自動的に Cを生成します. このファイルは GitHubで見やすいようにフォーマットされた リポジトリの情報を示すために使われてます. =head1 FUNCTIONS =begin original =over 4 =item C Does nothing on the user-side. On the author-side it will generate a C file using L from the POD in the file passed as a parameter. readme_markdown_from 'lib/Some/Module.pm'; If a second parameter is set to a true value then the C will be removed at C. readme_markdown_from 'lib/Some/Module.pm' => 'clean'; It will die unless a file name is given. =item C Like C but assumes that C has been called before and uses the filename stored there to generate the C. It then calls C with that filename. If this function is given an optional boolean parameter, that will be passed to C as well, indicating whether to clean up the generated C file at C time. =item C Like C, but affects the plain-text C file generation done in L. This function would be better placed in that module and might move there eventually. It is given here as a convenience because if you want to generate both C and C you can do this here without repeating the filename given in C. =item C A utility function that saves you from repeatedly naming a reference module from which to extract information. reference_module 'lib/Some/Module.pm'; is equivalent to: all_from 'lib/Some/Module.pm'; readme_from 'lib/Some/Module.pm'; readme_markdown_from 'lib/Some/Module.pm'; It will die unless a file name is given. Note that C will not work with L because that module is looking for a C or C string in C =back =end original =over 4 =item C ユーザ側では何も行いません. 作者側でパラメータとして渡されたファイルに 含まれる PODから Cファイルを Lを使って生成します. readme_markdown_from 'lib/Some/Module.pm'; 第二引数に真となる値が設定された場合, Cをした場合に Cを 削除します. readme_markdown_from 'lib/Some/Module.pm' => 'clean'; ファイル名が与えられない場合は dieします. =item C Cと似ていますが, Cが事前に呼ばれていることが前提であり, そこで指定されたファイルから Cの生成します. 内部では Cにその名前を指定して呼び出しています. この関数はオプショナルな booleanパラメータを指定することができます. Cと同様であり, Cをした場合に 生成した Cを削除します. =item C Cと似ていますが, Lを 使ってプレーンテキストの Cを生成します. この関数はそのモジュールがあり, 最終的にそちらを使うのであれば, いい選択でしょう. Cと Cの両方を生成したい場合に, all_fromに与えるファイル名を 繰り返し書くことがないので, 便利に使えるでしょう. =item C 情報の抽出を行うために参照するモジュールの名前を繰り返し書かないで済むようにする ユーティリティ関数です. reference_module 'lib/Some/Module.pm'; は以下と等価です. all_from 'lib/Some/Module.pm'; readme_from 'lib/Some/Module.pm'; readme_markdown_from 'lib/Some/Module.pm'; ファイル名が与えられない場合は dieします. Cは Lと合わせて利用することはできません. なぜならそのモジュールは Cから Cか Cという文字列を見つけようと するからです. =back =head1 BUGS AND LIMITATIONS =begin original No bugs have been reported. Please report any bugs or feature requests through the web interface at L. =end original 今のところ報告されたバグはありません. バグが見つかったり, 実装して欲しい機能がある場合は L ウェブインタフェースを使ってレポートしてください. =head1 INSTALLATION =begin original See perlmodinstall for information and options on installing Perl modules. =end original Perlモジュールのインストールについての情報とオプションについては perlmodinstallを 参照してください. =head1 AVAILABILITY =begin original The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit L to find a CPAN site near you. Or see L. The development version lives at L. Instead of sending patches, please fork this project using the standard git and github infrastructure. =end original このモジュールの最新バージョンは CPANから利用することができます. Lであなたに最も近い CPANサイトを探して見てください. もしくは L を参照してください. 開発中のバージョンは L にあります. パッチを送る代わりに, gitと githubの基盤を使ってこのプロジェクトを, ぜひ forkしてみてください. =head1 AUTHORS Marcel GrEnauer, C<< >> =head1 COPYRIGHT AND LICENSE Copyright 2009 by Marcel GrEnauer This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. =head1 SEE ALSO L L L =cut