プラグイン用ヘルプファイルの指定

プラグインのヘルプ ファイルは、html ページまたはコンパイルされたヘルプ ファイル(.chm)になります。

ユーザは次のようにさまざまな方法でヘルプにアクセスできます。

• プラグイン ツリーでプラグインを右クリックし、[ヘルプ]を選択します。

• プラグインに自己インストール プロパティが組み込まれている場合、プロパティ ページで、 タイトル バーの[？]アイコンをクリックします。

Script Editor で[F1]キーを押しても、カスタム コマンドのヘルプは開きません。 [F1]キーは、Softimage SDK ヘルプ ファイルに記載されているコマンド(およびオブジェクト、メソッド、プロパティ)にのみ有効です。

デフォルトで、Softimage がプラグインのヘルプ ファイルを検索する場所は、プラグイン インストール フォルダの Doc サブフォルダ内です。 Softimage では、ヘルプ ファイルにプラグインと同じ名前が付いていると想定されます。 たとえば、次のフォルダにプラグイン MyPlugin.js があるとします。

C:¥users¥sblair¥Softimage¥XSI_2013-SP¥Application¥Plugins¥MyPlugin¥

Softimage は、MyPlugin.chm、MyPlugin.html、または MyPlugin.htm という名前のヘルプ ファイルを見つけるために、MyPlugin¥Doc フォルダを調べます。

プラグイン ヘルプ ファイルの名前または場所が異なる場合、SIObject.Help または PluginRegistrar::PutHelp および SIObject.Help または PluginItem::PutHelp を使用して、ヘルプ ファイルの名前を指定し、オプションでそれらの場所を指定できます。たとえば以下のようになります。

// JScript
function XSILoadPlugin( in_reg )
{
	in_reg.Author = "sblair";
	in_reg.Name = "MyPlugin";
	
	// Help file is in the same folder as the plug-in
	var sChm = "MyPluginHelp.chm";
	in_reg.Help = XSIUtils.BuildPath( in_reg.OriginPath, sChm );
	
	var oPluginItem = in_reg.RegisterProperty("MyProperty");
	
	// Open a specific help topic for the property
	sChm = "MyPluginHelp.chm::/MyProperty.htm";
	oPluginItem.Help = XSIUtils.BuildPath( in_reg.OriginPath, sChm );
	
	//RegistrationInsertionPoint - do not remove this line
	
	return true;
}