Sandcastle January 2008 Release

(最終更新日時:2011-01-17 05:46:54)
Visual Studio で作成した XML ドキュメントから Help ファイルを作成するためのツール Sandcastle をインストールします。

ダウンロード

Sandcastle Installer - Sandcastle January 2008 ReleaseSandcastle.msi
また、GUIツールとして、
Sandcastle Help File Builder Installer - 1.6.0.4 ProductionSandcastleBuilderSetup_1604.zip

インストール

ダウンロードした Sandcastle.msi を実行します。
特に設定する個所はありません。

次に、GUIツール Sandcastle Help File Builder のインストールを行います。
ダウンロードした SandcastleBuilderSetup_1604.zip を解凍して作成される SandcastleBuilderSetup.msi を実行します。
これも特に設定する個所はありません。

日本語ローカライズ

Sandcastle Help File Builder では、作成する Help File の言語を日本語に設定できるのですが、 日本語のコンテンツファイルが同梱されていないため英語版で作成されてしまいます。

TimberLandChapel さんが日本語ローカライズしたコンテンツファイルを作成されていますので、使用させていただくことにします。
TimberLandChapelさんのTech Blog を参考に日本語コンテンツファイルをダウンロードします。
(コミュニティサイトへのメンバ登録が必要になります)

ダウンロードしたファイルを解凍し、Readme.txt に設定手順が記載されていますので、その手順に従って日本語コンテンツファイルを配置します。

XMLドキュメントファイルの作成

Visual Studio 2008でXMLドキュメントファイルを作成します。

ソリューションエクスプローラからプロジェクトを右クリックするか、ツールバーのプロジェクトでプロジェクトのプロパティを開きます。
sandcastle01.gif
(※)ビルドタブでXMLドキュメントファイルの出力にチェックを入れます。

プロジェクトのビルドを行うと、ソースのドキュメントコメントタグからXMLドキュメントファイルが作成されます。

ヘルプファイルの作成

Windowsのスタートメニューから Sandcastle Help File BuilderSandcastle Help File Builder GUI でGUIツールを起動します。
ツールバーの Project から New Project from Visual Studio Project で Sandcastle Help File Builder のプロジェクトを作成します。
sandcastle11.gif
(※)ヘルプファイル作成対象の構成を選択します。
(※)XMLドキュメントファイルを出力する設定が存在する構成のみ一覧表示されます。

sandcastle12.gif
(※)Addボタンでヘルプファイル作成対象を指定・追加することもできます。

XMLドキュメントファイルの存在しない参照ライブラリ等があれば、Unresolved assembly reference のエラーとなりますので、XMLドキュメントファイルの存在しないライブラリ等を設定しておきます。
sandcastle21.gif
(※)Builグループの Dependenciesプロパティで設定します。

sandcastle22.gif
(※)「フォルダ」「ファイル」「GAC(グローバル・アセンブリ・キャッシュ)」で設定することができます。

作成するヘルプファイルのフォーマットを設定します。
sandcastle31.gif
(※)Builグループの HelpFileFormatプロパティで設定します。

ヘルプファイルの出力設定をします。
sandcastle41.gif
(※)Help Fileグループの Languageプロパティで 日本語 (日本) を選択します。
(※)その他、必要に応じて CopyrightText, HelpTitle, HtmlHelpName 等の各プロパティを設定します。

ヘルプファイルに表示するメンバの設定をします。
sandcastle51.gif
(※)internalprivate のメンバを表示する場合は、それぞれ True にします。
(※)DocumentInheritedFrameworkMembersプロパティを False にすると、作成の速度がかなり速くなります。
(※)ただし、Frameworkの Help へのリンクは作成されません。

ヘルプファイルの作成を行います。
sandcastle61.gif
(※)ツールバーの DocumentationBulid Project で作成が開始されます。

a System House to build an Accounting system by the Computer Technology