再びのSandCastleネタ。
今回は、出来上がったヘルプに好きなドキュメントや説明、サンプル画面などのコンテンツを追加してみよう、というお話です。
こことかここのお話を過ぎてくると、ソースから生成したXMLタグを使って、HelpFileが作成できるのはもう普通。ではそこに、クラスダイアグラムや処理フローなどの上位設計に当たるドキュメントも同梱しちゃって、一つの技術文書コンテンツとしてHelpFileを位置づけられないかな、というところから話は始まったのですが……。以下の手順で、いかがっすか？
１．同梱したいコンテンツの作成
残念ながら、クラスダイアグラムや処理フローなど、必要なコンテンツをジェネレートしてくれる機能はSandCastle Help File Builderにはありません。(SandCastle VisualStadio2005 Add-inにあるのとのうわさですが未確認ｗ) が、PowerPoint、EXCELやWORDにはあります。「Htmlファイルで保存する」という方法です。これを使って、同梱したいドキュメントをどんどんHTML化していきましょう。ついでに、ここで美しいHTMLコンテンツにしておくと尚よろしいかと。もちろん自分でちまちまHTML作ってもOK。必要なのはHTMLコンテンツなんですから。
２．コンテンツをビルダーに同梱
SandCastleのプロジェクトを開きます。プロジェクトプロパティにある「AdditionalContents」をクリックすると、コンテンツ同梱設定用ダイアログが開くので、ここに１．で作成したHTMLを設定します。指定するときには、
ファイルが含まれるフォルダを指定さえしておけば、後は勝手にたどって入れてくれます。
３．コンテンツの位置を決める
ContentPlacementプロパティを設定して、コンテンツの位置をヘルプファイルの先頭にするか、備考として後ろにつけるかを選択します。これはヘルプファイルとなった時の目次の位置決めになります
「AvobeNameSpaces」：目次の先頭
「BelowNameSpaces」：目次の最後
４．ヘルプファイルをビルドする
ここから以降は一緒です。ファイルも大きくなるし、ビルド時間も長くなりますが、ノンビリ待ちましょう。ほんと、時間がかかるのよね、このビルドは（笑）
……完成！ HTMLファイルがヘルプコンテンツに取り込まれてこんな感じ♪ どんだけ～♪
ってことで、SandCastleで「基本設計書」は起こせるのか、という問いに関しては、「YES、ただし、同梱ドキュメントをHTMLコンテンツ化する努力は必要だよ」というのが答えです。PowerPointだとHTMLコンテンツ化が楽だし、EXCELでも結構やれんじゃないかと思います。WORDははじめっからHTML文書で作り始めないとダメダメだけどｗ てなカンジで、宿題、完了でいい？＞けろ理事