問題タブ [perl-pod]

AsciiDoc軽量マークアップ言語で書かれたマンページを Perl のPOD (Plain Old Documentation)に自動的に変換するには?

おそらく、DocBook から POD に変換するもの (AsciiDoc ソースからマンページ形式への変換、つまり troff は DocBook (XML 経由) 経由で行われます)。

I'm having a issue where pod2usage is missing text, and I have tried to fix it by:

1. converting newlines
2. rewriting it
3. checking it with podchecker

but none of these things help to resolve or hint to my problem

output of podchecker:

Full pod:

http://pastebin.com/igH8SamN

Pod2text output:

snip

snip

Info:

My OS is OpenSuSE 11.4 Linux 2.6.37.6-0.7-default i686 i686 i386, GNU/Linux

My editor is SciTE Version 1.77

Also The POD is embedded in Perl code and pod2text is called thru the following code:

Pod2text version: unknown ( not in man, info, help or pod2text --help )

Terminal info:

Edit: This bug seems to stem from Tk::Text, I tried pod2html in the console, and it seems ok, but in Tk it is missing text

perlpodドキュメントには、 or を使用して URL にリンクできることが 記載L<scheme:...>されており、例としてL<text|scheme:...>リストされています。L<The Perl Home Page|http://www.perl.org/>

最初のケースは私にとってはうまくいきますpod2html:

の中へ

しかし、それは失敗します

に変換されたばかりです

警告とともに：

私は次のようなものを期待していたでしょう

生産される。どうすればそれを達成できますか？

更新Pod::HtmlAlan Haggai Alavi が指摘しているように、これはバグのようです。回避策はありますか?

私は自分のperlドキュメントをPOD形式で書いています
。私の問題は、単に*という名前のアイテムラベルが欲しいということです。

=item *、、を試しまし=item S<*>た=item Z<>*=item E<42>

すべてのアプローチは箇条書きとして解釈されますが、アスタリスクを通常のテキストとして解釈したいのですが
、どのようにすれば、次のようなテキストを追加せずにこの問題を一般的に解決できます=item "*"か？

これが役立つかどうかはわかりませんが、ここに小さな例があります（空の行を放棄しました）：

pod2text、pod2htmlなどを使用する前に、podcheckerを使用してドキュメントをチェックしています。 すべてのコンバーターはポッドチェッカーの解釈に依存していると思ったので、そもそもこれを
言っていなかったと書いてあります=item type mismatch ('definition' vs. 'bullet')

複数の Perl スクリプト ファイルにまたがる一連の POD があります。別のファイルを使用して、これらすべての PODのランディング ページを作成したいと考えてい.podます。

たとえば、フォルダーに次の POD を/my/root/sub_folder/含むスクリプト ファイルがあるとします。FirstScript.pl

ファイルでは、TOC.pod次のようにそのセクションにリンクしようとしています。

私が実行すると：

エラーが発生します：

ファイル拡張子 (.pl) をコードのname一部に追加すると、リンクは解決されL<>ますが、結果の URL は「.pl .html」の形式になります。これは、個々の出力ファイルをどのようにしたいかではありません。

ここで何が問題なのですか？podrootandを意図しない方法で使用しpodpathていませんか?

Descriptionタブが出力に表示されるように、それぞれの前に2つのタブを挿入するにはどうすればよいhtmlですか?

WITH セクションのポッド リンクが機能しないことに気付きました。リンクがタイプミスされていることを確認しましたが、ソースをクリックすると、そうではなく、ポッドがそこにあることがわかりました。pod が metacpan.org または search.cpan.org で動作しないのはなぜですか (perldoc では動作するようです)。

更新: 修正後、問題が表示されなくなりました

PythonでPOD(plain old documentation)を使用できるかどうか疑問に思っていましたか? そして、どうすればいいですか？

私は、POD コメントが文書化されたコードの横にある、一種のリテラル プログラミング スタイルを好みます。残念ながら、これはコードを肥大化させますが、これはあまり Perlish ではありません ;-) 今のところ私が見つけることができる最良の方法は、次のようにPod::WeaverでDist::Zillaを使用することです:

空行を削除することを主張することもできますが、これは可読性も低下させます。次のような繰り返し不要な構文を使用せずに、より簡潔に記述する方法はありませんか。

そして、これを完全な POD に拡張します。

おそらく Pod::Weaver プラグインを使用する必要があると思いますが、Pod::Weaver と Dist::Zilla および PPI を組み合わせたアーキテクチャを理解しようとすると、頭が痛くなりました :-(

スクリプトのPODカバレッジを測定する方法はありますか（例*.pl）？

とを使用してパッケージのドキュメントカバレッジを測定できますが、スクリプトのドキュメントカバレッジを測定することはできません。これは、ファイルの不足が原因で失敗するパッケージのコンテンツを検査するための基本的な使用法であるためです。Pod::CoverageTest::Pod::CoveragePod::CoverageDevel::Symdumprequire.pm

これを回避する方法はありますか？

（ファイルにPODドキュメントが含まれている必要がある.plため、すべてをモジュールに移動してドキュメント化することは、私にとって良い解決策ではありません。それができるところならどこでも、すでにそのように行われています。）