問題タブ [perl-pod]

私がこのダミーのPerlパッケージを持っているとしましょうtest.pm：

Test::Spelling次に、コマンドラインから...を使用してスペルチェックを実行します。

...、および私の関数名envとhstはタイプミスとしてマークされていますが、hst_dir受け入れられます：

カスタム辞書をでリストできることは知っていますadd_stopwords()が、私の意見では、関数名のスペルチェックはまったく行わないでください。

ドキュメントの細かい部分を見逃しましたか？

これが不可能な場合、UTF-8でエンコードされたPODから派生したマニュアルページを処理するためのベストプラクティスは何ですか？

PODでUnicodeを使用するために最初に行うことは、ディレクティブを使用することです

（ここで説明されているように）。およびツールは正常に機能しpod2text、pod2html完全なUTF-8エンコード出力を生成します。

ただし、このpod2manツールは次のことを行いません。

どちらもしませんperldoc。非ASCII文字はすべてマングルまたはX-edoutされます。これがバグであるか**roff*であるかについて、perlbugに関するいくつかの決定的な議論があります。pod2man

私のモジュールは特にUnicodeを扱い、CPANでの配布を目的としているため、Unicode対応のマニュアルページは必須です。

私はPerl5.14.2、perldoc 3.15、および*roff1.21を使用しています。

間違った引数または引数の数が渡されたときに、PerlプログラムでPODの内容を出力するにはどうすればよいですか？

=headXDist :: Zillaと一連のプラグインを使用して、構文、リンク、カバレッジなどを含むポッドをチェックします。繰り返し続ける非常に厄介なPODの間違いの1つは、 ;の後に行を追加するのを忘れることです。たとえば、次のようなポッドを使用してモジュールを作成しました。

もちろん、私はCPANページを見て、段落全体がhead2形式であるため、それを台無しにしたことに気付きます。

=headX（または他の何か）と次の段落の間にスペースを入れるのを忘れていないことを確認するための良い自動化された方法はありますか？

スクリプトにヘルプ機能を追加する標準的な方法はありますか? 最も簡単な方法は、引数を取り、「-help」などのテキストを出力することです。これを行う方法の例はありますか?

ありがとう！

HTMLにエクスポートされるperlpodドキュメントを作成するときに、結果のHTMLファイルのタイトルをPODディレクティブに埋め込むことはできますか？

コマンドを使用して複数のPODテキストファイルをHTMLに変換できるようにしたいのですが、コマンドラインでパラメーターを指定pod2htmlする必要はありません。--title="My Title"

たとえば、perlpod形式のテキストファイルは次のとおりです。

HTMLに変換すると、pod2htmlはタイトルがないことを警告します。

結果のHTMLファイルでは、タイトルはファイル名（test.txt）に設定されます。

おそらく次のようなディレクティブを使用して、perpodドキュメントでタイトルを指定する方法を見つけたいと思います。

Perlのドキュメントでは、ドキュメントのタイトルが適切に設定されていることがわかります。これはすべて、ポッドドキュメント自体にドキュメントタイトルを含めずに実行されますか？

作業中のいくつかのスクリプト用の便利なライブラリを作成しました。Getopt::Long必須の引数を提供することに加えて、もう少し単純なものにラップします。そのため、ライブラリは、スクリプトの必須/可能なコマンドライン引数のリストにいくつかの引数を追加します。

スクリプトはフラグに対してpod2usageも呼び出すので--help、ライブラリが個々のスクリプトに提供するこれらの各フラグの定義を提供し、pod2usageが呼び出されたときにレンダリングできるようにする方法が必要です。

たとえば--dosomething、ライブラリによってフラグが追加された場合、とにかく、を実行するa.pl --helpと、によって提供されるヘルプ定義a.plだけでなく、ライブラリによって提供される定義も--dosomething含まれa.plます。

これを実現する方法はありますか？実行時にライブラリにスクリプトのPODを変更させる方法はありますか？

Dist::ZillaでPod::Weaverを使用します。それは私にとっていくつかの良いことをします。POD セクション VERSION、AUTHOR、LICENSE が自動的に追加され、ソース コードでは単純な POD 構文を使用できます。「=method new」と記述すれば、正しい POD に変換されます。

ここで、POD に画像を追加したいと思いました。そのためには、HTML を追加する必要があります。だから私は自分のソースコードに書いています:

次に、CPANでモジュールdzil releaseを作成してリリースします。CPAN にアップロードした後、私の HTML POD が Pod::Weaver によって変更されたことを認識し、現在は次のようになっています。

そして、この HTML 部分は POD に移動されました。SYNOPSIS部分の直後にしたかったのですが、最後のメソッドの後ではありません。

Pod::Weaver は多くの優れた機能を備えているため、引き続き使用したいと考えていますが、HTML を POD の正確な場所に配置し、変換しないようにしたいと考えています。

どうすればいいですか？

私は小さな perl モジュールを持っていて、Getopt::Long を使用しています。Pod::Usage を使用して見栄えの良いヘルプ表示を取得することも考えました。

少しいじった後、1つの小さな例外を除いて、かなりうまく機能するようになりました. 出力の幅を設定できません。

私の端末は 191 文字幅です。perldoc Module.pm を使用すると、ドキュメントがその幅に正しくフォーマットされます。pod2usage() を使用すると、デフォルト幅の 76 文字が使用されます。

width オプションをフォーマッタに渡す方法がわかりません。ドキュメントには、BEGIN ブロックを使用して別のフォーマッタ (Pod::Text::Termcap など) を設定する方法が示されています。Term::ReadKey を使用して幅を取得しました (検証済み) が、フォーマッタを取得できません。見てください。

ヒントはありますか？

テストしようとしている完全なモジュールと、それをロードするための小さなテスト スクリプトを次に示します。意味を理解するには、妥当な幅 (132 以上なので明らかです) のターミナルを開き、「./test.pl --man」の出力と「perldoc MUD::Config」の出力を比較します。 .

perldoc が追加する man ページ スタイルのヘッダーとフッターがなくても生活できますが、端末の幅を尊重 (および使用) したいと思います。

test.pl

およびMUD/Config.pm