Posts: 165
Registered: ‎12-08-2011
Message 1 of 4 (309 Views)
Accepted Solution

Plugin, Autoloader and Help-files

309 Views, 3 Replies
07-11-2013 07:20 AM



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




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




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

ADN Support Specialist
Posts: 341
Registered: ‎04-30-2009
Message 2 of 4 (296 Views)

Re: Plugin, Autoloader and Help-files

07-11-2013 09:51 AM in reply to: Robert_Fritz

It should work...


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



Augusto Goncalves
Autodesk Developer Network
Posts: 165
Registered: ‎12-08-2011
Message 3 of 4 (272 Views)

Re: Plugin, Autoloader and Help-files

07-11-2013 10:42 PM in reply to: Robert_Fritz



I tried different paths but none worked.



help file in same folder as packagecontents:




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?




ADN Support Specialist
Posts: 352
Registered: ‎07-24-2007
Message 4 of 4 (220 Views)

Re: Plugin, Autoloader and Help-files

07-17-2013 08:38 AM in reply to: Robert_Fritz

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


Fenton Webb

Developer Technical Services

Autodesk Developer Network

Are you familiar with the Autodesk Expert Elites? The Expert Elite program is made up of customers that help other customers by sharing knowledge and exemplifying an engaging style of collaboration. To learn more, please visit our Expert Elite website.
Need installation help?

Start with some of our most frequented solutions or visit the Installation and Licensing Forum to get help installing your software.