問題タブ [sandcastle]

Sandcastle Help File Builder を使用してアプリケーションのドキュメントを作成しようとしています。次のように、Msdn キャッシュ コンポーネントを .shfbproj ファイルに追加しました。

$(MsdnCachePath) プロパティの値は次のとおりです。

問題は、ヘルプ ファイルが生成された後、このキャッシュ ファイルがこの場所に作成されないことです。これが起こらない理由はありますか？

Sandcastle Help File Builder を使用してアプリケーションのドキュメントを作成しようとしています。要件の 1 つは、次のようなドキュメント ソースを指定する必要があることです。

次のように、別のファイルで @(DocumentationSourceFiles) を定義しました。

次に、このファイルを .shfbproj ファイルにインポートし、上記のように使用しました。問題は、@(DocumentationSourceFiles) がアイテムのリストとしてではなく、単なる文字列として認識されていることです。私は何か間違ったことをしていますか？@(DocumentationSourceFiles) を次のような単一の値を持つプロパティに変更するとします。

そして、次を使用します。

すべて正常に動作します。何か案は？

以下を含む C# API のドキュメントを作成しています。

1. doc/pdf ファイルとしての現在の状態の一般的な概要と説明。
2. Sandcastle を使用した .chm ファイル内のクラス ライブラリ API。

質問:

1. これら 2 つを同じ .chm ファイルにマージする必要がありますか? それらをマージする良い方法は何ですか?
2. 特定のクラス/パッケージを除外する必要があります。SandCastle でそれを指定するにはどうすればよいですか?
3. VB コードと Visual C++ コードのドキュメントを生成します。どうすればこれを変更できますか? それとも、安全なコードのみを使用していることを知って、そのままにしておく必要がありますか?
4. システムのどこで HTML Help 2.x Viewer Path を見つけることができますか?

編集：

上記のメソッド、フィールド、およびクラスに関するコメントは、ドキュメントには生成されません。

私は何をすべきか？

Sandcastle コンパイルの出力をソース管理に追加しようとしていますが、Sandcastle には、サブバージョン管理のディレクトリ構造に直接出力しようとすると問題があります。

だから、私がやろうとしていたのは、管理されていないディレクトリに出力してから、svn で管理された構造に robocopy することです。/MIR を使用して古いファイルを削除したいのですが、問題は、これにより robocopy がすべての svn プロパティのものを一掃することです。

それで、私が望む方法で robocopy を使用する簡単な方法はありますか、それとも別の解決策がありますか?

サンドキャッスル ヘルプ ファイル ビルダー プロジェクト (.shfbproj) を Visual Studio 2008 ソリューションに追加する方法

このような要件を満たすヘルプ/ドキュメント生成ツールを探しています。

• C# コンパイラによって生成された xmldoc コメントをサポートするか、(さらに良いことに) サンドキャッスルを直接サポートする必要があります。
• MS Word ドキュメントのインポートをサポートする必要があります。
• 概念ドキュメントからソース コードから生成された参照ドキュメントへのリンクの作成をサポートする必要があります。
• MS Word での概念的なドキュメント オーサリングがサポートされているとよいのですが

詳細。私のプロジェクトは、.NET のフレームワーク/ライブラリです。合計で 50 以上の C# プロジェクトを含む複数の VS ソリューションがあります。まず、プロジェクトのソース コードからヘルプ (将来的には chm & help2 & help3) を生成したいと考えています。そのドキュメントを「参照ドキュメント」と呼びます。サンドキャッスル (特にSCFBを使用した場合)）これは非常に良い方法で行うことができます。しかし (非常に一般的な状況だと思います)、フレームワーク/ライブラリに関する追加のドキュメントがあります。そのドキュメントは MS Word ファイル (5 ～ 10 ファイル) です。そのドキュメントを「概念ドキュメント」と呼びます。概念ドキュメントと参照ドキュメント (MSDN など) を備えた堅固なヘルプ システムを作成したいと考えています。また、ヘルプの概念部分には、フレームワーク/ライブラリからのすべての .NET タイプ名のヘルプの参照部分を参照するリンク (URL) が含まれている必要があります。(明らかに、どのヘルプ システムも最終的には単なる HTML です)。

問題は、これらのリンクを作成する方法です。MS Word ファイルは、C# xmldoc について何も知りません。Sandcastle は Word ファイルをサポートしていません。そのため、ヘルプ オーサリング ツール (HAT) を使用する必要があります。今のところ、適切なツールが見つかりません。そして、私はどんな助けにもとても感謝しています!

すべてのツールの障害は、リンクの自動作成です。生成中にリンクが自動的に作成されるようにします (ビルド サーバーで実行できます)。なぜ自動的に？型の名前を簡単に変更できるためです。たとえば。概念ドキュメントにテキストがあります:「リクエスト処理コンテキストにアクセスするには、XOperationContext タイプの静的プロパティ Current を使用します」。ここで XOperationContext は型名です。結果ヘルプシステムの XOperationContext クラスの仕様へのリンク (URL) を、さほど手間をかけずにできるようにしてほしいです。Word（おそらくHATのプラグインがインストールされている）またはHATのエディターで、「可能であればこの単語をリンクする」のようなものとしてマークしたいと思います。生成中に、そのような名前の型名があれば、そのような単語はそれぞれリンクになります。

私はこれらのツールについて知っています：

• Toolsfactory Doc-o-Matic (現在使用中)
• Innovasys DocumentX と HelpStudio
• ComponentOne Doc-to-Help

Doc-o-Matic サポート リンクの自動作成。本当に自動的に。PascalCase の各単語のリンクを作成しようとします - 見事です。ただし、MS Word には対応していません。Innovasys および ComponentOne のソフトウェアは、リンクの自動作成をサポートしていません。Innovasys のソフトウェアは MS Word をサポートしていません (これについては 100% 確信が持てません)。

Innovasys と ComponentOne のフォーラムで質問してみました。これまでのところ運がありません。私のような Innovasys のソフト サポート シナリオ: 別のツール (HelpStudio) で概念的なドキュメントを作成し、別のツール (DocumentX) でソース コードからヘルプを生成する。ただし、リンクを自動的に作成して MS Word ファイルをインポートする機能はありません。

ですから、その一般的なタスクの有効期限を共有してください (一般的なはずです)。

ps 英語の文法の観点から自分の考えを正しく説明できていない場合はお知らせください。もう一度試します。

SandCastle Help FileBuilder1.8.0.1とそのMAMLコンテンツエディターを使用しています。

デフォルトの1以外の値から始まる順序付きリストが必要です。

10. Some data

11. Other data

私は次のことを試しましたが、OL要素のHTMLからのように機能しません。

どうすればこれを達成できますか？

サンドキャッスルスタイルでどのファイルを変更する必要があるか誰かが知っていますか？

次のような長い名前空間を持つ大規模なプロジェクトがあります

Sandcastle を使用して名前空間のドキュメントを作成しますが、これらの長い名前空間は、最終的な chm ファイルのコンテンツ ペインの表示を台無しにします。Component.Class少なくとも Treeview パネル だけに表示するにはどうすればよいですか?

および/または、コンポーネントの下のすべての名前空間に展開し、展開CompanyNameするルートノードとして持つ可能性がありますか?ProductComponent