8

私はMavenを再訪している最中です。Mavenが1.xから2.xに再設計していた時期であったため、これを最後に確認したとき、私たちのチームは悪い経験をしました。そのため、必要な依存関係の多くが新しいリポジトリに移動されていませんでした。 。しかし、今は再考する時間があります。

ドキュメントの作成にMavenとLaTeXまたはDocBookのいずれかを使用することに興味があり、共有する経験、プロジェクト/モジュール構造、使用する優れたプラグインなどを誰かが持っているかどうか疑問に思いました...

どうもありがとう ：-）

編集：

明確にするために、私は技術的な記事/本を書くことを探していました、そして私の望ましいアーティファクトはおそらくPDFでしょう。

4

7 に答える 7

7

DocBook は、Maven によってドキュメントを生成するために使用されるエンジンである Doxia への多くのサポートされている入力の 1 つです。ここを参照してください: http://maven.apache.org/doxia/modules/index.html

実際、Doxia サイトはあなたの正確な質問に答えています: http://maven.apache.org/doxia/book/index.html

于 2008-11-05T12:59:08.137 に答える
6

mvn site コマンドを使用して (つまり、プラグイン siteを使用して) Maven で (ドキュメントを含む) サイトを簡単に作成できます。

このプラグインは技術レポート (Javadoc、単体テスト レポート、コード カバレッジなど) を作成しますが、「実際のサイト」の作成にも使用できます。詳細については、このページを参照してください。

基本的に、 APT (理解するのが非常に簡単なほぼプレーン テキスト) または XML ベースの形式であるXdocを使用してページを記述します。

2 年前、XDoc 形式と Site Maven プラグインを使用して、開発した 1 つのアプリケーションの完全なユーザー ガイドを作成しました。全体的に、作成は非常に簡単でした！

これがお役に立てば幸いです。

于 2008-11-05T12:21:50.163 に答える
3

私は Maven プラグイン Docbkx をうまく使用してきました。あなたはそれを試してみるべきです

Docbkx

于 2009-03-19T14:43:56.750 に答える
2

Maven Docbkx Pluginを必ず確認してください。それはおそらくあなたのニーズに合っています。Doxia の DocBook のサポートは - うーん - 最適ではありません。実際、私が最後に試したとき、私の知る限り、DocBook ではない何か新しいものが生成されました。

私が言及している Maven Docbkx プラグインは、世界のすべてのカスタマイズをサポートしています (プラグイン パラメーター、またはそれに興味がある場合は XSLT オーバーライドを介して) + Maven ビルドと統合するためのいくつかのメカニズムを備えています。(Maven pom プロパティをドキュメントに含めるための処理命令など。)

野心は、手動で処理チェーンを自分で組み立てる必要がないようにするプラグインを用意することです。したがって、このプラグインは FO への変換と、それを PDF に変換する両方を行います。

于 2009-08-30T15:39:27.817 に答える
0

最近、docbook と maven 用の docbkx プラグインを使用して、maven マルチモジュール プロジェクトのプロジェクト ドキュメントを実装しました。プロジェクト サイトをビルドするたびに、html ファイルと pdf ファイルを自動的に生成するようになりました。docbkx は非常に優れていると思うので、それを使用することをお勧めします。

確かに、maven サイトと doxia プラグインを使用するだけで、非常に優れたサイトを作成できます。実際、私はこれらの 2 つを使用してプロジェクト サイトを生成していますが、docbook に対する doxia のサポートは非​​常に限定されており、たとえばメイン ドキュメント内のドキュメントの一部を含むドキュメントをモジュール化することはできません。そのため、大きなリファレンス マニュアルには docbkx を使用しています。

のぞき見したい場合は、私のプロジェクトはこちら. 実際にソースをダウンロードして、その核心を見ることができます。もちろん、このセットアップに関してご質問があれば、喜んでお手伝いさせていただきます。

乾杯カルロス

于 2013-06-14T15:33:59.597 に答える
-3

私の知る限り、LaTeX または DocBook を処理する公式または半公式のプラグインはありませんが、(前述のサイト プラグインを使用する以外に) できることは、サイトのライフサイクル中に LaTeX/DocBook ソースを処理するように exec プラグインを構成することです。プロジェクトのウェブサイトが構築されるのと同時に。

たとえば、次のようなもの

<plugin>
  <groupId>org.codehaus.mojo</groupId>
  <artifactId>exec-maven-plugin</artifactId>
  <executions>
    <execution>
    <id>latex</id>
    <goals>
      <goal>exec</goal>
    </goals>
    <phase>site</phase>
      <configuration>
          ...
      </configuration>
    </execution>
  </executions>
</plugin>
于 2008-11-05T12:33:54.117 に答える