3

Javaサーバースタイルのアプリケーションを構築するためにMavenを使用しています。これは、複数のモジュール (単一の Maven "reactor" 内) で構成され、それらを接続して、顧客が必要とする機能を有効にした最終製品 (基本的には .jar) を生成できます。すべての内部構造は JavaDoc などを使用して文書化されていますが、それを顧客に提供して、物事を実行する方法を見つけてもらうことはできません。現在、エンドユーザーのドキュメントとして機能する OpenOffice ドキュメントがあります。

このドキュメントを Maven ビルド プロセスに統合したいと考えています。そこでは、各モジュールのドキュメントがモジュールのソースと共に維持 (手作業で編集) され、最終的なドキュメントは必要なモジュール ドキュメント セクションを参照でき、わかりやすい序文を追加できます。すべて、JavaDocs を参照できます。最終的に、ドキュメントは PDF として出力する必要があります。

これに役立つMavenプラグインの経験はありますか? DocBook は適切なツールですか? もしかしてラテックス？それともまったく違うもの？「OpenOffice といくつかのテキスト ブロックに固執する」というサウンドも答えになる可能性があります。

4

4 に答える 4

1

maven-site-pluginを使用したMaven サイトのドキュメント生成をまだ見ていないと思います。これは非常に堅牢で、OpenOffice ドキュメントのコンテンツだけでなく、JavaDoc 生成も組み込むことができます。

サイトのドキュメントは PDF として出力されませんが、多くの機能が組み込まれている静的な HTML Web サイトとして出力されます。 Maven プロファイルを使用すると、Surefire のテスト結果とCheckstykle や PMD などのチェックに関するその他のレポート。別のプロファイルでは、クライアントが気にしない可能性のある内部レポートを含まない、クライアントへの配布に必要なドキュメントのみを生成するように構成できます。

ただし、サイト ドキュメントの生成の多くが Maven 3 用に変更されていることに注意してください。Maven 3 のほとんどは Maven 2 と下位互換性がありますが、Maven 3 のレポートの変更に注意してください。これらのリンクを確認してください。

于 2011-01-11T15:25:39.817 に答える
0

もう1つの解決策は、DocBookをPDFに変換するためのMavendocbkxプラグインです。HTMLなど。

DocBookのコンテンツがMavenで生成されたサイトにも表示されるようにしたい場合は、変換されたDocBookをHTMLにMavenプロジェクトサイトに追加する方法についてこの説明をお読みください。

興味深い関連質問：

于 2011-04-01T11:10:05.887 に答える
0

また、外部ドキュメントを含むサイト プラグインでは十分な品質が得られない場合は、Docbook を Maven で使用して、HTML および PDF 出力を生成できます。実際、Sonatype はすべての書籍 (Maven: The Complete Reference、Nexus 書籍、M2Eclipse 書籍など) でこれを行っており、それらはオープン ソースであるため、すべてがどのように機能するかを確認し、セットアップをコピーして必要に応じて変更することができます。docbook を使用する利点は、ツールが非常に優れていること (xmlmind など) と、索引や目次などを備えた印刷品質の本を作成できることです。

ああ、あなたが言ったので、Maven用のLaTeXプラグインもありますが、私はそれについての経験がありません（しかし、Mavenを使用する前にLaTeXをかなり使用していました...）

于 2011-03-31T18:45:24.760 に答える