topic Re: Plugin, Autoloader and Help-files in .NET Forum

Plugin, Autoloader and Help-files

Anonymous — Thu, 11 Jul 2013 14:20:43 GMT

Hi,

with any plugin you can provide a help file as well which needs to be specified in packagecontents.xml, e.g.:

HelpFile="./Contents/maplayereditor.htm"

Unfortunately it doesn't work for me - when I place the cursor on my plug-in icon in the ribbon and press F1 I just end up at

http://docs.autodesk.com/errors/404.htm

How is the help system for plugins supposed to work? Has anyone successfully used the help system?

I have AC Map 2013 Sp2,

Many thanks, Rob

Re: Plugin, Autoloader and Help-files

augusto.goncalves — Thu, 11 Jul 2013 16:51:14 GMT

It should work...

Make sure the relative path is correct (from the PackageContent.xml) and you have specified the AppNameSpace="appstore.exchange.autodesk.com"

Re: Plugin, Autoloader and Help-files

Anonymous — Fri, 12 Jul 2013 05:42:06 GMT

Hi,

I tried different paths but none worked.

Examples:

help file in same folder as packagecontents:

HelpFile="./maplayereditor.htm"

HelpFile="maplayereditor.htm"

I put the file in subfolders as well and set the path - to no avail.

Not sure about the "appnamespace":

AppNameSpace (optional) : This is an additional app namespace string, it is currently only used by the Autodesk AppManager to indicate Autodesk specific products.

I don't want to put anything on appstore. Why is it required for the help system?

Anyway - is my assumption correct that the htm file I have configured in packagecontext.xml should be displayed in a browser when I press "F1" whilst hovering the mouse over my plugin button in the ribbon?

Is anything else required to configure the help system correctly? Just the html file in the right folder and path set in the xml file?

Rob

Re: Plugin, Autoloader and Help-files

fenton_webb — Wed, 17 Jul 2013 15:38:04 GMT

Your original path was correct - it relates to the bundle folder/Contents/Resources/MyHelpFile

This helpfile (localizable) is the quick start guide for your app, it is accessable :

1) At the end of the AppStore installer

2) The first time the App loads inside of AutoCAD, a tooltip will appear informing of the load status with a link to your app's quick start

Pressing F1 on a Ribbon, is a whole different system which is documented elsewhere - it's currently not supported directly by the autoloader