Avatar of Skip Sleeper
Skip Sleeper
 asked on

MS Access create end user help files

Hi Experts,

I am finally completing my first Access application and am very confused about the best way to provide help files to end users.  My latest attempt is to create a small cmd button with the an embedded help icon and place it on controls.  These call a message box because which works great but I thought message box modality could be turned off and I would like these to be available as users interface certain controls.  The help file editors available online seem to be to overkill for my small db and there doesn't seem to be a built-in Access option to create these.  There are posts (on other forums but couldn't find any on EE) about using tables/forms with the controls' contextID, but I'm not clear if these work with F1 key on when the control has focus or does this involve the same tactic I'm now employing.  Any advice, direction or pointers would be greatly appreciated and I really appreciate your time--thank you!
Microsoft Access

Avatar of undefined
Last Comment
crystal (strive4peace) - Microsoft MVP, Access

8/22/2022 - Mon
crystal (strive4peace) - Microsoft MVP, Access

hi Skip,

attached is a zip with 4 files:

    Forms_With_Help_Examples_s4p.accdb
    SampleFormHelp.doc
    SampleFormHelp.htm
    ReadMe.txt

Forms with Help Examples
The Access 2007 database has 3 sample forms showing different ways to display Help using:

    HyperlinkAddress
    UnboundObjectFrame
    RichText

~crystal
Forms_With_Help_Examples_s4p.zip
Skip Sleeper

ASKER
Hi Crystal,

Thank you for the insights and samples!  In the textbox example, would the HelpID=1 refer to a control's help context ID?  How would this typically be called (e.g. F1, icon cmd button)?  Thanks!
crystal (strive4peace) - Microsoft MVP, Access

you're welcome, Skip.

Attached is another example. It uses an AutoKeys macro to define the F1 key to open the Help form, which is filtered for a specific topic. A tempvar is used for the HelpID. Look at the code behind the TEST form to see how the HelpID can be changed. I used command buttons to change the help topic -- but you might want to use GotFocus to set a specific topic and LostFocus to set it back to general form help.

AutoExec macro: automatically executes when application is opened. Set HelpID to 0 (for general application help)

AutoKeys macro: defines F1 key

form Open defines general help for form
form Unload sets help back to 0

I think this is easier to manage than using built-in Help

~crystal
HelpFormPopup_AutoKeys_F1_s4p.zip
This is the best money I have ever spent. I cannot not tell you how many times these folks have saved my bacon. I learn so much from the contributors.
rwheeler23
Skip Sleeper

ASKER
Hi Crystal,

Just to clarify, the TEST form would list all the help topics when called by F1?  And does the HelpID correspond to the helpContextID of controls or this not even used?  What do mean by "built-in" Help?  Lastly, do you think the memo fields increase DB size dramatically as an application grows?

Thanks!
Skip
ASKER CERTIFIED SOLUTION
crystal (strive4peace) - Microsoft MVP, Access

THIS SOLUTION ONLY AVAILABLE TO MEMBERS.
View this solution by signing up for a free trial.
Members can start a 7-Day free trial and enjoy unlimited access to the platform.
See Pricing Options
Start Free Trial
GET A PERSONALIZED SOLUTION
Ask your own question & get feedback from real experts
Find out why thousands trust the EE community with their toughest problems.
Mark Edwards

For what it's worth, I don't use help files (too much work to create and maintain).  I just create a word document "users manual" that I export to .PDF and then open with a button click using FollowHyperlink() function.  Any time a modification needs to be made, just make it in your Word .docx and export to .PDF again...

Simple and it works beautifully.....
Skip Sleeper

ASKER
Thank you Crystal and Mark--got a lot to think about!
⚡ FREE TRIAL OFFER
Try out a week of full access for free.
Find out why thousands trust the EE community with their toughest problems.
crystal (strive4peace) - Microsoft MVP, Access

you're welcome, Skip ~ happy to help

Mark's idea to maintain Help in Word bears consideration and is a helpful comment ...  even if what you do is copy and paste into Access. It is easier to format text in Word.