Best use of SDK help from an external editor in 2021

SDK Help

SDK Help

If your editor supports the launching of external programs and allows you to insert text to the command line based on your current selection, then you can get context sensitive help from the XSI SDK help file. This will work for both the C++ and scripting SDKs. This snippet shows how to perform this in the Crimson Editor but it will work equally well in any other well supported editor that has this feature.

– – – – – – – – –

If you tend to only use commands in your scripts, then I recommend this method (which only works for commands):

In your editor, find where the settings are for launching external applications via a keyboard shortcut. For Crimson Editor, you can find this in the “Tools->Conf. User Tools” menu. Enter the command as:

C:\WINDOWS\hh.exe

And the argument as:

mk:@MSITStore:C:\Softimage\XSI_5.0\Doc\XSISDK\xsidevref.chm::/$(CurrWord).htm

Note that you’ll need to set the path to the help file so that it’s correct on your system. Also, if you’re not using Crimson Editor, then you’ll need to change where it says $(CurrWord) to the correct macro for your editor, so that it adds the currently selected word to your command argument.

Now just associate this tool with a shortcut key, e.g. F1, and you should now be able to launch the SDK help with a single key press to get instant reference for your command. As I said above, this only works for commands, since it relies on the naming convention of the compiled help.

– – – – – – – – –

If you want to have general context sensitive help that will work with any method, property, or command in your script, then you need to download KeyHH.exe from Keyworks

Once you’ve installed it, just use these settings:

Enter the command as:

C:\WINDOWS\keyhh.exe

And the argument as:

-myhelp -#klink “$(CurrWord)” C:\Softimage\XSI_5.0\Doc\XSISDK\xsidevref.chm

As mentioned above, you’ll need to change the path to work for your help file and change the $(CurrWord) macro to suit your editor.

When you launch this command, it will open the SDK help file in Index view using the word selected in the editor. Unfortunately it doesn’t display the help page automatically, and you still need to double click the entry, but it beats the heck out of having to type it! Thanks to SDK Help!

Leave a Comment