RE: help files for compiled self-installing plugins

["Stephen Blair" <Stephen_Blair(at)Softimage.COM>]

Hi Kim

 

It looks like you have to use PPGLayout.PutAttribute to set the siUIHelpFile attribute. That gives the the help icon just above the tabs.

 

XSIPLUGINCALLBACK CStatus MyOp_DefineLayout( CRef& in_ctxt )
{
    Application app;
    app.LogMessage( L"DefineLayout" );
    Context ctxt( in_ctxt );
    PPGLayout oLayout;
    PPGItem oItem;
    oLayout = ctxt.GetSource();
    oLayout.Clear();

    oLayout.PutAttribute( siUIHelpFile , L"C:\\My Documents\\test.chm" );

    return CStatus::OK;
}

---

From: owner-xsi(at)Softimage.COM [mailto:owner-xsi(at)Softimage.COM] On Behalf Of Kim Aldis
Sent: Thu 04 January 2007 9:40 AM
To: XSI(at)Softimage.COM
Subject: RE: help files for compiled self-installing plugins

Hi Stephen,

 

This is for 6.0. Originally I was using the PluginRegistrar PutHelp method. I’m building a operator rather than a property so I amended to this, based on your example:

 

CString sHelp     = L"TinyMeshDeform.chm";

      p.PutHelp( CUtils::BuildPath( in_reg.GetOriginPath(), sHelp) );

 

which gave me an error saying it couldn’t find a huge great big long path to the chm file, for the first time, so I modded  the code as below:-

 

CString sHelp     = L"TinyMeshDeform.chm";

      p.PutHelp( sHelp );

 

Now I’m getting no error and I see a ppg as below. The top ‘?’ icon gives me an XSI property doc page. Normally I’d expect to see another icon just above the tabs but I’m not seeing that.

 

 

 

From: owner-xsi(at)Softimage.COM [mailto:owner-xsi(at)Softimage.COM] On Behalf Of Stephen Blair
Sent: 04 January 2007 14:04
To: XSI(at)Softimage.COM
Subject: RE: help files for compiled self-installing plugins

 

 

 

Hi Kim

 

Is this for 5.0 or 6.0?

 

In 6.0, this worked for me:

 

PluginItem p = in_reg.RegisterProperty(L"MyProperty");

p.PutHelp( L"C:\\My Documents\\test.chm" );

 

---

From: owner-xsi(at)Softimage.COM [mailto:owner-xsi(at)Softimage.COM] On Behalf Of Kim Aldis
Sent: Thu 04 January 2007 4:34 AM
To: XSI(at)Softimage.COM
Subject: help files for compiled self-installing plugins

Does anyone have even the remotest clue about how to get help files for compiled, self-installing plugins working? I’ve tried both a chm and html path using PutHelp() in the load callback and checked the path is valid. I’ve also tried an html with a netview_ prefix to the name of the plugin but I still can’t see a help button in the ppg. How can something so simple become so time-consuming?

 

 

 

 

www.kim-aldis.co.uk   |   kim(at)kim-aldis.co.uk