Sandcastle は Visual Studio で作成した xml コメントをヘルプファイルや web ヘルプにコンパイルするためのツールです。
今回は,この Sandcastle May 2008 Release のインストールと日本語ドキュメントを生成するためのローカライズについてまとめます。
この記事は,
Visual Studio 2005 Servide Pack 1 に基づいて記述しています。
この記事は以下のブランチにわかれています。
Sandcastle January 2008 のインストレーションレポート(May 2008 と基本路線は変わりません)
http://blogs.timberlandchapel.com/blogs/timberlandchapel/archive/2008/03/22/sandcastleInstall.aspx
Sandcastle May 2008 のローカライズ
http://blogs.timberlandchapel.com/files/folders/visual_studio/entry2267.aspx
Sandcastle January 2008 のヘルプ作成
作成中
Help 1.x は chm 形式にコンパイルされてすぐに確認できるので簡単ですが,
おそらく Help 2.x の HxS 形式は結構手を焼くんじゃないでしょうか。。。
Visual Studio で [Help Integration Project] を組んでしまうのが一番楽そうなんですが,このあたりについてまとめる予定
Sandcastle May 2008 日本語ローカライズファイルの変更点
Jan 2008 to May 2008
[hana reference_content.xml]
ADD
<item id="SeeAlsoOverloadLinkText">{0} オーバーロード</item>
[Prototype shared_content.xml]
Update
<item id="copyright">2005 Microsoft Corporation. All rights reserved.</item>
<item id="copyright">2008 Microsoft Corporation. All rights reserved.</item>
[Shared syntax_content.xml]
DELETE
<!-- JavaScript messages -->
<item id="UnsupportedUnsafe_JavaScript">JavaScript ではアンセーフ型を扱う API はサポートされていません。</item>
<item id="UnsupportedGeneric_JavaScript">JavaScript ではジェネリック型やジェネリックメソッドはサポートされていません。</item>
<item id="UnsupportedExplicit_JavaScript">JavaScript では明示的なインターフェイスの実装はサポートされていません。</item>
<item id="UnsupportedOperator_JavaScript">JavaScript では演算子のオーバーロードはサポートされていません。</item>
<item id="UnsupportedStructure_JavaScript">JavaScript では構造体の使用をサポートしていますが,新たに宣言することはサポートされていません。</item>
<item id="UnsupportedCast_JavaScript">JavaScript では新しい型変換演算子の宣言はサポートされていません。</item>
[vs2005 shared_content.xml]
ADD
<!-- freshness date -->
<item id="UpdateTitle"><font color="DarkGray">更新日時: {0}</font></item>
ADD
<item id="JavaScriptLabel">JavaScript</item>
<item id="XAMLLabel">XAML</item>
UPDATE
<item id="MailToLink">BLOCKED SCRIPTSubmitFeedback('<include item="fb_alias" />','<include item="fb_product" />','<include item="fb_deliverable" />','{0}','{1}','<include item="fb_body" />');</item>
<item id="MailToLink">BLOCKED SCRIPTSubmitFeedback('<include item="fb_alias" />','<include item="fb_product" />','<include item="fb_deliverable" />','{0}','{1}','<include item="fb_body" />','<include item="fb_subject" />');</item>
UPDATE
<item id="MailToLink">BLOCKED SCRIPTSubmitFeedback('<include item="feedback_alias" />','<include item="feedback_product" />','<include item="feedback_deliverable" />','<include item="feedback_fileVersion" />','<include item="feedback_topicVersion" />','<include item="feedback_body" />');</item>
<item id="MailToLink">BLOCKED SCRIPTSubmitFeedback('<include item="feedback_alias" />','<include item="feedback_product" />','<include item="feedback_deliverable" />','<include item="feedback_fileVersion" />','<include item="feedback_topicVersion" />','<include item="feedback_body" />','<include item="feedback_subject" />');</item>
[vs2005 reference_content.xml]
ADD
<!-- Security Critical Boilerplate text-->
<item id="typeSecurityCriticalBoilerplate">この型は SecurityCriticalAttribute 属性を持っているため,使用は .NET Framework for Silverlight クラス ライブラリでの内部用に限定されます。アプリケーション コードでこの型の任意のメンバを使用すると,MethodAccessException 例外がスローされます。</item>
<item id="memberSecurityCriticalBoilerplate">このメンバは SecurityCriticalAttribute 属性を持っているため,使用は .NET Framework for Silverlight クラス ライブラリでの内部用に限定されます。アプリケーション コードでこのメンバを使用すると,MethodAccessException 例外がスローされます。</item>
<item id="securityCritical">[SECURITY CRITICAL] </item>
[vs2005 feedBack_content.xml]
ADD
<item id="fb_subject">カスタマーフィードバック</item>
ADD
<item id="feedback_subject"></item>
[vs2005 conceptual_content.xml]
ADD
<item id="autoOutline"><autoOutline/></item>
SHFB 1.7.0.0 日本語ローカライズファイルの変更点
1.6.0.4 to 1.7.0.0
[SharedBuilderContent_ja-JP.xml]
ADD
<!-- SHFB Show Missing Component messages -->
<item id="shfbAutoDocConstructor"><see cref="T:{0}"/> クラスの新しいインスタンスを初期化します。</item>
<item id="shfbAutoDocStaticConstructor"><see cref="T:{0}"/> クラスの静的フィールドを初期化します。</item>
<item id="shfbMissingTag"><p style="color: #dc143c; font-size: 8.5pt; font-weight: bold;">[Missing &lt;{0}&gt; documentation for "{1}"]</p></item>
<item id="shfbMissingParamTag"><p style="color: #dc143c; font-size: 8.5pt; font-weight: bold;">[Missing &lt;{0} name="{1}"/&gt; documentation for "{2}"]</p></item>