Specifying a Help File for a Plug-in


You can specify a html page as the help file for a plug-in.

You can access the help for a plug-in in the following ways:

NotePressing F1 in the script editor does not open the help for a custom command. This action works only for commands, objects, methods, and properties described in the Softimage SDK help.

By default, Softimage looks for a help file in a Doc subfolder inside the plug-in installation folder. The help file must have the same name as the plug-in. For example, consider that the plug-in MyPlugin.js is located in the following folder:


In this example, the help file must be named MyPlugin.html or MyPlugin.htm and it must be saved in the MyPlugin\Doc subfolder.

If a plug-in help file has a different name or location, you can use SIObject.Help, PluginRegistrar::PutHelp(), or PluginItem::PutHelp() to specify the help file. For example:

// JScript
function XSILoadPlugin(in_reg)
	in_reg.Author = "xyz";
	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, "MyPlugin.htm");
	var oPluginItem = in_reg.RegisterProperty("MyProperty");
	// Open a specific help topic for the property
	oPluginItem.Help = XSIUtils.BuildPath(in_reg.OriginPath, "MyProperty.htm");
	//RegistrationInsertionPoint - do not remove this line
	return true;
NoteFor html pages, you cannot include a destination anchor. For example, MyPlugin.htm#command.

Creative Commons License Except where otherwise noted, this work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License