v4.0
オブジェクトのヘルプファイルをStringとして指定します（オブジェクトにヘルプファイルがない場合は空の文字列が戻されます）。
Help プロパティは、PluginRegistrarおよびPluginItemを除くすべてのオブジェクトで読み取り専用です。
プラグインのヘルプファイルは、HTML ページまたはコンパイルされたヘルプファイル（.chm）になります。
デフォルトでは、プラグインインストールフォルダの"doc"サブフォルダ内で、プラグインのヘルプファイルが検索されます。Softimage
では、ヘルプファイルにプラグインと同じ名前が付いていると想定されます。たとえば、プラグインMyPlugin.jsが"C:¥MyWorkgroup¥Application¥Plugins"フォルダにある場合、"C:¥MyWorkgroup¥Application¥Plugins¥Doc"フォルダにあるMyPlugin.chm、MyPlugin.html、または
MyPlugin.htm という名前が付いたヘルプファイルが検索されます。
プラグインのヘルプファイルに別の名前が付いていたり、別の場所に置かれている場合は、PluginItem または
PluginRegistrar
オブジェクトでこのプロパティを設定して、ヘルプファイルの名前と場所（オプション）を指定できます。
注：
動的なカスタムプロパティ（SceneItem.AddCustomPropertyで作成されたプロパティ）のヘルプファイルを指定する場合は、PPGLayout.SetAttributeを使用してsiUIHelpFile
属性を設定してください。
SPDL
オブジェクトのヘルプファイル文字列には、セミコロンで区切られたヘルプファイルの場所とインデックスが含まれます。たとえば、"HelpFile;HelpID"のようになります。ここで、HelpFile
はオブジェクトのヘルプファイルを示し、HelpIDはヘルプファイルのインデックスの識別子を示します。
/*
This example shows how to specify the help
for a plug-in and for a custom property.
*/
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;
}
|
'
' This example shows how to specify help files for a plug-in
' and for specific plug-in items. The help files are assumed
' to be in the "doc" subfolder of the plug-in installation folder.
'
Function XSILoadPlugin( in_reg )
' register plugin information
in_reg.Author = "Softimage Co."
in_reg.Name = "Mesh Filter plugin"
in_reg.Help = "MeshFilter.htm"
in_reg.URL = "http://www.softimage.com"
in_reg.Email = "webmaster@softimage.com"
' set the version number of this plugin
in_reg.Major = 1
in_reg.Minor = 0
' register filter plugin items
set item = in_reg.RegisterFilter( "Border Edge", siFilterSubComponentEdge )
item.help = "BorderEdge.htm"
set item = in_reg.RegisterFilter( "Triangle", siFilterSubComponentPolygon )
item.help = "Triangle.htm"
in_reg.RegisterFilter "Quad", siFilterSubComponentPolygon
in_reg.RegisterFilter "N-gon", siFilterSubComponentPolygon
in_reg.RegisterFilter "Border Point", siFilterSubComponentPoint
in_reg.RegisterFilter "Polygon Island", siFilterSubComponentPolygon
XSILoadPlugin = true
end Function
|
/*
This example shows how to get the plug-in items help files
*/
var items = Application.Plugins("Mesh Filter plugin").Items;
for (var i=0; i<items.Count; i++)
{
Application.LogMessage( items(i).Name + " help file is " + items(i).Help );
}
|