How does F1 key know which help topic to display

[artdove]

We are a 3rd party developer with our own help file (compiled html - chm). I am trying to hook up our help so that when a customer hovers over one of our icons, the proper help topic is displayed (currently we get the default AutoCAD help main page).

Specifically, how is this all connected? When F1 is hit, the help system must look at an item topic, but how? Is it hard wired to the exact command name (ie, LINE, ARC, etc)? Must the index item be named the same thing? Or can it be tied to a resource entry in the help index file? I looked in the CUI, but only extended tooltips can be added there, and can be selected for each topic.

HELPPREFIX stores just one location for the index file. Does this mean that if I change that to point to our index file, that AutoCAD's own help files are disconnected? Must the index file be in the same location as the help files? Can the help system remain in a compiled (chm) format or must all the individual topic html files be stored individually?

Most customization topics have extensive (amazing) documentation. I cannot find anything on this one, however.

[Sea-Haven]

These may be primitive answers re help.

In a dcl you can have a help button. 

In my pop menu we have help it either opens a file not a html file, the file can be a doc, a txt, or a movie, or be restricted to a staff location so no unapproved users.

I have paper copies of old manuals and did find Autocad has .hlp files start with acad.hlp, no idea past this point.

Can you not just open your html file  and go to correct item ?

[artdove]

Thanks.

Yes, I can, but we are a 3rd party developer and want our customers to be able to hit F1 over a toolbar or ribbon button to get the relevant help. I have long had the help files wired into the dcl buttons, but this is a whole different animal.

[Sea-Haven]

This may help flyouts in toolbar maybe can have as help ?

AutoCAD LT 2023 Help | To Customize a Toolbar Flyout | Autodesk

Just an undocumented copy a cuix then rename to .zip you can open and look inside, you will be surprised what it reveals.

[paullimapa · Accepted solution]

There's only one helpfile I'm aware of which AutoCAD supports for plug-ins and it needs to be in html format and defined inside the PackageContents.xml file.  This file needs to be located under your plugin application folder. The plugin application folder needs to follow a naming format with .bundle as suffix & located under one of these folders the AutoCAD application looks for plugins and automatically loads at startup:

C:\ProgramData\Autodesk\ApplicationPlugins

C:\Users\your-windows-profile\AppData\Roaming\Autodesk\ApplicationPlugins

You can read up more on how this is all structured under these links:

https://forums.autodesk.com/t5/visual-lisp-autolisp-and-general/give-me-a-bundle-of-lisp-file-so-tha...

https://anweshgangula.hashnode.dev/bundle-distribute-autocad-api-plugin 

https://www.keanw.com/2011/09/autodesk-exchange-preparing-your-autocad-application-for-posting.html

[artdove]

Thank you. I will pursue this lead and consider this the answer unless I run into a dead end

[paullimapa]

glad to have helped...post again if you need further assistance on this topic...cheers!!!