問題タブ [doxia]

Doxiaを使用してドキュメントを生成したいのですが、Ant で呼び出します (いいえ、Maven はオプションではありません)。いくつかのポインターを探していましたが、Googleで数回検索しても何も表示されませんでした。

Doxia を Ant 環境で既に使用している人はいますか? その結果はどうでしたか?

いくつかの関連プロジェクトの Maven サイト ドキュメントに取り組んでおり、あるサイトのドキュメントから別のサイトのドキュメントへのハイパーリンクを作成したいと考えています。問題は、リンク ターゲットの URL が Maven プロパティに依存することです。

私はこれを試しました：

しかし、${some-prop} プレースホルダーは置き換えられず、APT プロセッサは最初の '}' によって混乱します。{ および } 文字 (例: $\{some-prop\}) をエスケープしても役に立ちません。また、次のコードも機能しません。

このタスクを達成できる他の方法はありますか? たとえば、プレースホルダーが展開された URL を置き換えるために使用できる Doxia マクロを定義する方法はありますか?

サンプル コード スニペットを JUnit でテストできるようにするために、Maven サイト ドキュメントでスニペット マクロを使用したいと考えています。しかし、すべてのプロジェクトで Eclipse に赤い「ビルド エラーがあります」というマーカーを表示させたくありません (m2eclipse がスニペット マクロを認識しないため、表示されます)。Eclipse のプロジェクトで Maven 依存関係管理を有効にしたいので、Maven 統合を完全に無効にすることはできません。同僚全員に Eclipse からの切り替えを強制することもできないため、別の IDE への移行もオプションではありません。

次のいずれかの解決策が必要です。

• (m2)Eclipse の Doxia 統合でスニペット マクロを認識または無視するようにします。
• Eclipse が apt ファイルのエラーを完全に無視するようにする

短縮版

見栄えの良いPDFを生成できるMavenDoxiaの代替手段が必要です（少なくともコードスニペットは適切にインデントされ、フォントサイズを構成できる必要があります）。Mavenの連中はDOXIA-419でmaven-pdf-pluginを提案しましたが、同じ問題があります。前述のDOXIA-419には、Doxiaで経験した問題の詳細が記載されています。

詳細版

Java / C / C ++ / C＃/etcAPIを提供するBIG製品を開発しています。クライアントがカスタマイズした数十のブランチが同時に保守/開発されます。これらの要件を満たす自動ドキュメント生成を容易にするツールが必要です。

1. Java / XML/etcサンプルからの任意のスニペットを含めます。Confluenceスニペットプラグインはこの機能の良い例です。

2. 見栄えの良い印刷可能なドキュメント（PDFなど）を生成します。

3. クリック可能な相互参照など（HTMLなど）を持つオンラインドキュメントを生成します。

4. 無人モード（たとえば、Antスクリプトからドキュメント生成プロセスを簡単に実行できる必要があります）。

5. ドキュメントのソースコンテンツ（後でPDFなどが生成される）は、人間が読める形式で保存する必要があります。

6. ドキュメントのソースコンテンツは、（Javaソースではなく）別のファイルに保存する必要があります。

7. （Java / xml / etc）構文の強調表示をサポートします。

更新：8。WindowsOSの互換性。

たとえば、Mavenサイトをマークダウンで書き込むことが可能であることを知っています。

http://code.google.com/p/doxia-module-markdown/wiki/Usage

マークダウンや休憩で書かれた本を作成することも可能ですか？で説明されているように、本の記述子を使用してこの作業を行うことはできませんでした

http://maven.apache.org/doxia/book/index.html

セクションが記述されているマークアップ言語をdoxiaに伝えるにはどうすればよいですか？

私は現在、私たちのプロジェクトの 1 つのドキュメントを書き始めています。簡単にするために、Almost Plain Text (APT) 形式を使用することにしました。詳細については、http: //maven.apache.org/doxia/references/apt-format.htmlを参照してください。

APT は最小限の構文を使用するため、優れたドキュメント形式です。そのため、APT について詳しく知らなくても、ドキュメントの作成や変更を非常に簡単に行うことができます。

しかし、コードをうまくフォーマットする方法が見つかりませんでした。ソースコードを含めるために使用できるコードタグまたは類似のものはありますか? FML を使用できることは承知していますが、これはあまり望ましくありません。

ありがとう

Doxia APT形式を使用して、テーブル内に逐語的なテキストまたはスニペットを含めたいと考えています。

ただし、doxia の逐語的なテキストとマクロはどちらもインデントされていない必要があり、表には前にマークアップが必要であるため、これを簡単に実現できる方法があるかどうかはわかりません。

具体的には、適切なドキュメントを含むサイト ドキュメントを生成するために Maven 3 を使用しています。テーブル列に複数行の JSON 表現を含めたいと考えています。

回避策として、各行を等幅にし、いくつかの json 文字をエスケープする必要があります。これは、読み取りや保守が容易ではありません (ただし、レンダリングされたページは問題なく表示されます)。例えば：

理想的には、テーブルの読みやすさを維持するために、doxia スニペットまたは同様のマクロを使用してコードを動的に挿入することを好みますが、逐語的なテキストを使用することもできます。たとえば、次のようなことができるようにしたいのですが、これは有効ではありません。

これを達成する方法はありますか？

maven-site-plugin と markdown (doxia-module-markdown) で生成されたコード スパン内にドル記号を表示したいと考えています。

コード範囲外で、数値コードを使用し$て問題を修正しました。しかし、コード スパン (4 つのスペース) 内では、数値コードはデコードされません。これは実際には驚くべきことではありません。

コード ブロック内では、アンパサンド (&) と山かっこ (< と >) は自動的に HTML エンティティに変換されます。

( http://daringfireball.net/projects/markdown/syntax#codeから)

また、ドル記号を 2 つ ( $$)、エスケープ ( \$)、チャーム( ) しようとしまし<3$たが、何も機能しませんでした。

誰かが何か考えがありますか？

Maven サイトのドキュメントでは、セクションに次のようなコードを使用しています。

セクション名/タイトルを HTML ローカル アンカーにしたいのですが、どうすれば Doxia に伝えることができますか? http://maven.apache.org/doxia/references/doxia-apt.html#Anchorsはこれについて話していますが、私はそれを<section>s に適用できませんでした。

3 つの apt ファイルがあるとします。

main.apt

child1.apt

child2.apt

DRY (自分で繰り返さない) の原則に従い、main.apt のテキストを再利用して、child1.apt と child2.apt に追加したいと考えています。これは、ドキュメントを書くのに本当に役立ちます。

スニペットを使用してみました (最初に ID を使用してサイト ドキュメントを生成し、次にそれらの ID への参照を追加しました):

を使用して生成されたサイト

、しかし、htmlとしてフォーマットされていないhtmlテキストのブロックを挿入するため、これは機能しません。スニペットで verbatim パラメータも試しましたが、役に立ちません。

たぶん、誰かがこの問題の解決策を持っているか、同じ問題に直面していますか? あなたのストーリー、提案を教えてください。解決策は私の日を救うでしょう:)