問題タブ [help-files]

ユーザーの観点から、この質問を SuperUserに追加しました。

そこで、デスクトップ システムで実行される Delphi または .NET でアプリケーションを作成します。あらゆる種類の機能と優れた機能を備えた優れた GUI。それはうまく機能し、テストではほとんどバグがないことがわかり、私はそれを展開しようとしています...

待つ！ユーザーがアプリケーションから状況依存のヘルプを呼び出すことができるように、ヘルプ ファイルが必要です。

か否か？ヘルプファイルは、最近のデスクトップ アプリケーションにとって本当に必要なのでしょうか? また、ユーザーの手を握って、「生年月日」というラベルの付いたこのフィールドに生年月日を入力する必要があることを伝えるために、状況に応じたものにする必要がありますか? それとも、ヘルプファイルが少し時代遅れになりつつありますか?

これは私が疑問に思っていることであり、これは少し主観的なものです。その代わりに、デスクトップ アプリケーションを開発しているすべての皆さんに別の質問をするつもりです:状況依存のヘルプファイルを (まだ) 提供していますか?

はい、またはいいえでお願いします。主観的なテキストを自由に追加してください。しかし、私にとって重要なことは、現代の開発者がまだ状況依存のヘルプを GUI アプリケーションに追加しているかどうかを知ることです。

(ちなみに、私自身、マニュアルとして印刷できるコンテキストのない PDF ファイルに移行しました。これは、保守がはるかに簡単です。)

現在作成しているapplescriptスタジオアプリケーションのヘルプファイルを生成する方法を知りたいです。ヘルプを作成するためのさまざまなオプションを試しましたが、かなり長い間グーグルで検索しましたが、答えが見つかりません。

アプリケーションのメニュー項目「アプリケーションヘルプ」をクリックすると、ヘルプを作成しようとすると、空のウィンドウでヘルプビューアが開きます。

私は現在、Xcode2.4.1でTigerを実行しています。

ヘルプビューアで私が見た中で最もクールな機能の1つは、継承されたメンバーを非表示にして、その特定のサブクラスが提供するものだけに集中できるようにする機能です。この良い例はここにあります...

http://james.newtonking.com/projects/json/help/html/T_Newtonsoft_Json_JsonConvert.htm

実際、そのページには、継承されたメンバーを非表示にするだけでなく、ヘルプを表示する方法に関するさまざまなオプションがあります。

現在、オンラインのMSDNには、サブクラスが何を追加したかを理解しようとすることを意味する、すべてを太陽の下に投げ込む習慣があります。それに到達するには、大量のスキャンとさらに多くのスクロールが必要です。

そうは言っても、これらの機能または同様の機能を有効にする方法は、ローカルまたはオンラインでありますか？これまたは同様のことを行う外部またはサードパーティのヘルプビューアを作成した人はいますか？

（注：これがプログラミング用ではないため、SO用かどうかはわかりませんが、IDE関連のものであるため、ギャンブルをしてここに置くことにしました。）

マーク

私は WinForms アプリケーションを開発しており、それにヘルプを統合したいと考えています。過去に、.chm ヘルプ ファイルを統合しました。

.chm ファイルに関して、このWiki 記事には次のように記載されています。

2002 年、Microsoft は .CHM 形式に関連するセキュリティ リスク、およびセキュリティ速報とパッチを発表しました。その後、.CHM フォーマットをこれ以上開発しない意向を発表しました。

私が読んだことによると、Microsoft Help 2.x は、VS 2008 および Office 2007 で使用されているヘルプ エンジンで、ファイル拡張子が .hxs のヘルプ ファイルを使用していました。

Office 2010 では何が使用されていますか? 推奨されるヘルプ ファイル形式は何ですか?

アップデート：

このトピックに関する役立つ情報が記載された次の MSDN 記事を見つけました。

アプリケーションの互換性: ヘルプ エンジンのサポート

アプリケーション用の chm ファイルを作成したいと考えています。利用可能な最高かつ最も簡単なフリーソフトウェアはどれですか? HTML Help Workshop を試してみましたが、とても難しいです。フリーソフトはありますか？

「ヘルプ」オプションがある他の2つのアプリケーションをインストールするアプリケーションがあります。これらの各アプリケーションには共通のヘルプファイルがありますが、「目次」でアプリケーション用に選択されたインデックスに基づいてコンテンツを表示する必要があります。1つのアプリケーションを開くと、その特定のアプリケーションのヘルプが表示されます。

Appl1のコードは次のようになります。

Appl2では次のようになります

このことから、共通のヘルプファイルのコンテンツページのみが表示され、選択されている特定のアプリケーションヘルプは表示されません。Appl1を実行しましたが、メインは表示されますが、自動的に選択され、右側に表示されるコンテンツは表示されMyAppません。Appl1

私はVS2010、C＃を使用しています、事前にフォームに勝ちます

質問は本当にそれをすべて言います。WPF アプリケーションを作成している場合、アプリケーション ヘルプをどのように統合していますか? 2013 年半ばの状況は?

検索エンジンを使用した午後から、これに対する明確な答えはないようですが、いくつかのオプションがあります。

1. 独自の凝ったツールチップ ベースのヘルプを作成します (ただし、どこからデータを取得していますか?)

2. .CHM ファイルと Windows Forms ヘルプ システムを使用します (私には古風に思えます)。

3. Microsoft Help Viewer 1.X または Microsoft Help 2.0 を使用してください。

   • どちらがより最近のものであるか、MS によって承認されているかについては、多少の混乱があります。Microsoft Help 2.0 よりも、Help Viewer 1.X の方が推奨されるオプションのようです。名前が似てるから仕方ない…
   • 2.0の状況は？使うべきですか？完全に展開されたことはありますか？

4. サードパーティ製品を使用して、ヘルプ ファイルを作成し、何らかの方法でそれらにリンクします - DocToHelp/NetHelp、NetAdvantage オンライン ヘルプなど...

さらに、必要なコンテキストを提供するために使用している XAML ベースのマークアップ/属性は何ですか? 推奨される方法は何ですか?

WPF でアプリケーション ベースのヘルプをサポートするための明確な道筋がないのは驚くべきことです。

S3 と S4 のメソッドを組み合わせたパッケージがあります (ええ、知っていますが、sort()、as.matrix() などの S4 を作成しようとしています...)。だから私はCRANの古典的なroxygen2（バージョン2.2.2）に固執します

何を試しても、Rd ファイルの使用タグが自動的に入力されないことに気付きました。@usage を使用して手動でそれを行うことができることはわかっていますが、かなり広範なコード ベースがあり、誤ってどこかでタグを見逃したくないので、自動化しておきたいと考えています。

例：

これをパッケージにラップし、roxygen2 (およびそれが重要な場合は RStudio) を使用して roxygenize し、ヘルプ ファイルを確認すると、次のようになります。

\usage セクションが見つかりません...

具体的には、私が考えている CHM ヘルプ ファイルはPHP ユーザー マニュアルです。このファイルをドキュメント内の特定の関数参照 (ノード) に直接開くことができる方法が欲しいです。このような：

その ↑ 構文だけが正しくありません。それはマニュアルを TOC に開いてしまうだけです。CHM ファイルはコマンドライン引数を受け入れることができますか? それらを特定のノードに直接開く方法はありますか?