« ORA-28009: SYSでの接続はSYSDBAまたはSYSOPERで行う必要があります | トップページ | Visual Studio 2010 F# Express Edition »

2009年11月 2日 (月)

[Sandcastle Help File Builder] 画像を埋め込む方法

XML コメントには、 どんな XML 要素でも整形式でありさえすれば記述できます。 Visual Studio は、 知らない XML 要素はそのままスルーして書き出してくれます。 ということは、 最終的にどんなドキュメントの表現になるかは、 コンパイル時に吐き出された xml ファイルを処理するツール次第、 ってことになります。

Sandcastle Help File Builder を使った場合は、 img 要素を使って画像を埋め込むことができます。
20091102_sandcastle01

ここでは、 画像ファイルを Images フォルダに置きました。 Visual Studio のプロジェクトファイルが置いてあるフォルダの直下に、 Images フォルダを作りました。

XML コメントは、 次のように記述します。

''' <summary>
''' XML コメントに img タグを入れてみるテスト。<br />
''' <img src="..\Images\bw.png" />
''' </summary>
Public Class Class1

20091102_sandcastle03

src 属性で指定する画像へのパスは、 ソースコードの位置からの相対ではない、 という点に注意してください。 これは Sandcastle がビルド時に使用するワークフォルダ内の html フォルダからの相対パスです。

Sandcastle Help File Builder (ver.1.8 の場合) の設定は、 次のようにします。
1. メニュー [File] - [Project Explorer] - [Files] -[Add] - [Existing Folder...]
2. 開いた 「フォルダの参照」 ダイアログで、 前述の Images フォルダを選択して、 [OK] ボタン。
3. すると、 プロジェクトエクスプローラーに Images フォルダと、 その中のファイルが追加される。 使いたい画像ファイルのプロパティを見て、 "BuildAction" が "Content" になっていることを確認しておく。
20091102_sandcastle02

あとは普通に Sandcastle Help File Builder でドキュメントを生成すれば、 最初のキャプチャのように画像を埋め込んだヘルプが出来上がるはずです。

※ 元ネタ: Sandcastle Help File Builder - Discussions - how to embed an image to a namspace summary

|

« ORA-28009: SYSでの接続はSYSDBAまたはSYSOPERで行う必要があります | トップページ | Visual Studio 2010 F# Express Edition »

プログラミング」カテゴリの記事

コメント

できるはずなのに自分でやるとなかなかうまくいかず、すごく助かりました。あと画像はヘルプファイルに埋め込まれました。

投稿: tueda | 2013年2月28日 (木) 16時36分

コメントを書く



(ウェブ上には掲載しません)


コメントは記事投稿者が公開するまで表示されません。



トラックバック

この記事のトラックバックURL:
http://app.cocolog-nifty.com/t/trackback/209349/46652813

この記事へのトラックバック一覧です: [Sandcastle Help File Builder] 画像を埋め込む方法:

« ORA-28009: SYSでの接続はSYSDBAまたはSYSOPERで行う必要があります | トップページ | Visual Studio 2010 F# Express Edition »