RibbonX - Is it possible to add help (F1) for a macro?

**dschmitt** · 07-06-2010, 09:27 PM

if one hovers the mouse pointer over a custom button a popup window appears that says "Press F1 for more help".
Is it possible to add an instruction manual for the macro that is executed by the custom button to the help menu?
If it is not possible, please somebody say so.

**Launchnet** · 07-06-2010, 11:36 PM

How many macros are you going to have that you want help info or instructions on?

How big of an instruction manual do you want? If it's over 1/2 page, suggest you use Word for the instruction manual. I think Word can be locked so that the user can not modify. Word can be opened automatically from a macro.

A sample or dummy spreadsheet showing where your macro's are going to be located, quantity and those that are to have manuals associated. You can dummy in the macro buttons by coloring cells in approximate locations..

I'll reply after you submit information.

It would also be good to know what verison of Excel your using.

**dschmitt** · 07-07-2010, 12:12 AM

it is not only one macro. I have 4 macros and 3 checkBoxes in one customGroup. All of this packaged in one Excel addin. In the manual I want to explain how all these functions work together. Its going to be a manual of at least 5-10 pages with lots of screen shots. I attached a xlsm file showing the customGroup in the Ribbon. I want to access the manual via the dialogBoxLauncher.

I have the feeling that adding the manual to the Excel help menu is not an option. An alternative is the Word option you mentioned. I definetely want to here more details about this strategy. Would it also be possible to use an Excel sheet?

In any case, what I would like to have is that the manual is embedded in the Excel addin.

I am using Excel 2007.

**royUK** · 07-07-2010, 12:40 AM

I don't think you can add your help File to the F1 help.

To write a help file you can produce a *.chm file which you can open from your code. There's various help file writing programs available.

Alternatively you could have UserForm display the help,depends on complexity

THre's no code in your attachment nor amendment to the ribbon

**dschmitt** · 07-07-2010, 01:28 AM

a chm help file is a good idea. I have to look into that. I first need to get a chm file creator ...

Related question:
I want to keep the addin distribution as simple as possible. Which means, I would like to send out only the xlam file.
How should I deal then with the chm file? Can that be embedded into the xlam file? Or do I have to distribute the chm file together with the xlam file?
If the later is the case, where should the chm file be kept? Is there a designated folder for such help files?

**royUK** · 07-07-2010, 01:51 AM

You distribute the chm file with the addin,I keep it in the same folder & my code opens it,you can specify the page in your code.

**dschmitt** · 07-07-2010, 02:03 AM

keeping the addin together with the chm in one folder is a good idea. I will do that.
Regarding specifying the page. Do you mean that I can access from every checkBox and every button in my customGroup the relevant page in the chm file?

**royUK** · 07-07-2010, 03:28 AM

You can write your code to open the relevant page

**dschmitt** · 07-07-2010, 03:34 AM

I see. Thank you for letting me know. This concludes this thread. I will start another thread later after I have finished the chm file to find out the details about how to code the link to the chm file pages.