6

マニュアルの生成に使用できるドキュメントの単一のソースを作成するために利用できるOSS （または無料）ツールは何ですか？具体的には、次の形式で：

  • HTMLWebサイト
  • PDFドキュメント
  • 埋め込み（アプリケーション内、場合によってはHTML）1
  • テキスト（オプション）
  • マニュアルページ（オプション）

追加要件：

  • ツールはテクニカルライターに適しています（WYSIWYGである必要はありません）。
  • XML/SGMLソース
  • 高品質のPDF出力（TeXに匹敵）
  • マルチプラットフォーム

拡張された要件1

同じコマンドラインアプリケーションが2つの言語（CとJava）で記述されています。XMLを使用してコマンドラインオプション（一部はいずれかの言語に固有）を記述すると、XMLをJavaクラスまたは標準出力にヘルプを書き込むC関数に変換するのは簡単です。これにより、外部ファイルに依存することなく、ヘルプをバイナリに埋め込むことができます。

AsciiDocにはこの機能がないようです。別のオプションはありますか？

4

4 に答える 4

6

私が以前に使用した、ほとんどの要件を満たすものはAsciiDocです。

AsciiDocはXMLソース形式ではありませんが、代わりに単純なテキスト形式を選択します。HTMLとDocbookを出力でき、PDFまたはその他の形式でレンダリングできます。ソーステキストは、プレーンテキストのプレゼンテーションにもほぼ十分です。

同じ行に沿ったもう1つの人気のある選択肢はreStructuredTextです。

于 2009-08-16T03:05:46.380 に答える
2

私は、エンジニアリング グループで Word に代わるものとしてDocBookを伝道することを検討してきました。利用可能なツールチェーンが多数あります。エンジニアにとって最も簡単なのは、おそらくDocBook XSL、Apache FOP、およびAntまたはMakeのいずれかです。これが私のDocBookのやり方です。LaTeX に本当に興味がある場合は、DocBook から LaTeX へのパブリッシング環境であるDBLaTeXをチェックしてみてください。

無料環境の外に出ても構わないのであれば、<oXygen/>XML エディターは非常に優れた WYSIWYG DocBook エディターを提供します。私はそれをあまり使用していませんが、かなり有望に見えます。

于 2009-08-16T03:20:30.247 に答える
2

Doxygenは非常に人気のあるドキュメント ジェネレーターで、さまざまな形式でドキュメントを出力できます。(多数の言語の) ソース コメントから抽出したドキュメントを作成することが主な目的ですが、一般的なマニュアル作成ツールとしても非常に便利です。実際、Doxygen の Web サイトとマニュアルはこの方法で生成されています。

于 2009-08-16T03:38:26.630 に答える
1

Sphinxは、Docutils に多くの機能を追加するツールであり、「インテリジェントで美しいドキュメント」を reStructuredText で記述できるようにします。もともとは新しい Python ドキュメントを作成するために作成されましたが、他の多くのプロジェクトで採用されています。

于 2009-08-16T03:24:45.977 に答える