8

エンドユーザー向けのクロスプラットフォームヘルプファイルを作成するための優れたオーサリングツールは何ですか？（私たちのアプリケーションは、Qtフレームワークを使用していますが、違いがあります。）

注：内部APIドキュメントには興味がありません。そのためにdoxygenを使用しています。

理想的には、ソリューションは次のようになります。

  • すべてのヘルプコンテンツ（テキスト、目次、画像など）を1か所で管理できるようにします。
  • ネイティブヘルプ形式に出力します。（CHM for Windows-または少なくともHTMLヘルプAPIに直接フィードできるもの。他のプラットフォームの「標準」ヘルプ形式が何かわからない。）
  • 適切なWYSIWYGサポート：一般的なテキスト入力、画像、相互参照などを簡単に処理できますが、必要に応じてHTMLを編集できます。
  • Subversionでバージョン管理できるように、ヘルププロジェクト（XMLなど）用のテキストベースのファイル形式。
  • 実際のコードベースとの同期を維持するのに役立つフックは素晴らしいでしょう。（おそらく、ヘルプトピックがコードファイルに関連付けられており、Subversionをチェックして変更が加えられているかどうかを確認し、トピックに「おそらく古い」というフラグを立てることができます...私は夢を見ていますか？）
  • ヘルプコンテンツはローカライズできます。
  • 商用製品とは対照的ではありませんが、無料のオプションがあればいいのですが。

先に進み、これをwikiにして、いくつかの例から始めます。それらの経験がある場合は、賛成または反対に投票し、コメントを残してください。追加のツールも追加します。

4

6 に答える 6

4

私はスフィンクスを発見しました; 私は恋をしていると思います。

  • HTMLよりもWYSIWYGよりも優れている：reStructuredText
  • QtHelpへの出力（とりわけ）なので、アプリケーションに簡単に配布（および統合）できます。
  • ローカリゼーションについてはまだわかりませんが、必要に応じてその橋を渡ります。
  • セットアップが簡単で、「正しく機能」しました。プロフェッショナルに見えます。
于 2010-06-09T13:52:51.003 に答える
2

私は何年もrobohelpを使用しています。

それは問題ありませんが、コアテクノロジーは現在非常に古いものです。また、Wordバージョンにロックする方法は完全なPITAです（そして、MS Officeのアップグレードを数回回避することを余儀なくされました）。

マッドキャップフレアに移行しますhttp://www.madcapsoftware.com/products/flare/robohelp.aspx

于 2010-08-30T00:20:42.427 に答える
2

DocBookは、同期フックを除いて、すべての要件に対応していると思います。同期フックについては、もう少し詳しく説明します。これは基本的に、ドキュメントを作成するために設計されたXMLのサブセットであり、無料でオープンソースです。これは、Docbookをより便利な形式（HTML、つまりCHM、JavaHelp、XML-FOまたはTex経由のPDF）に変換する一連のXSL出力変換に加えた形式です。

つまり、実際に編集するにはXMLオーサリングツールを選択する必要があるため、WYSIWYGなどはXMLオーサリングソフトウェアの機能に依存します。Syntext Sernaは、WYSIWYGとXML #includesのインライン編集を適切にサポートしているため使用します（後者をサポートしている人は他にいないようです）。他のXMLオーサリングツールがニーズに適している場合があります。Sernaは手頃な価格の商用製品です。

Docbookは、プロファイリングを介して多くの柔軟性を提供します。これにより、属性に基づいてxml要素を含めたり除外したりできます。ユースケースの例としては、OS=Windowsのヘルプ出力とOS=Linuxのヘルプ出力がわずかに異なる場合があります。ローカリゼーションは、プロファイリングやその他のメカニズムによってもサポートされます。

Docbookのかなり良い入門書はここにあります。

ヘルプ形式にはDocbookを使用し、特定の製品に関連する機能のみのヘルプを含むCHMファイルにコンパイルします（つまり、Enterprise Editionには、標準バージョンまたはデモバージョンにはない機能があります）。関連する手順は次のとおりです。

  1. XMLソースでプロファイリングXSLテンプレートを実行します（XSLTprocなどを使用）。
  2. 1の出力でHTML-HelpXSLテンプレートを実行します。
  3. MicrosoftのHTMLヘルプコンパイラ（HHC）を使用して、出力HTMLファイルをコンパイルします。
于 2010-08-30T01:35:16.807 に答える
1

ヘルプとマニュアル

于 2010-06-04T20:05:26.743 に答える
0

ロボヘルプ

于 2010-06-04T20:04:33.283 に答える
0

私が知っているのは、latex2htmlコンバーターの1つであるLatexと、結果のhtmlをCHMアーカイバ用に準備するためのいくつかの調整だけです。

  • text、html、chm、pdf、ps問題ありません。
  • 以前は災害であったRTFを介したWordへの変換は、現在の状況がわかりません。
  • ラテックス2htmlコンバーターは、いくつかありますが、すべて独自の問題があります。
  • PDFは絶対に素晴らしく見えます。
  • WYSIWYM（lyx経由）が可能です。

このアーカイブには、そのように多数のCHMがあります（特にprog、ref、およびuser部分、残り（rtl、fcl、lcl）は、同等のdoxygenであるfpdocによって生成されます）

http://www.stack.nl/~marcov/doc-chm.zip

上記のCHMは、独自の（ポータブル）CHMコンパイラで作成されていることに注意してください。はい、これ以上のワークショップはありません。

PDFおよびhtmlとしてのLyxドキュメント：

pdf：http ://www.stack.nl/~marcov/buildfaq.pdf

html：http ://www.stack.nl/~marcov/buildfaq/

于 2010-06-11T11:31:29.630 に答える