Before defining object-level help text for your custom or external objects, review these best practices and implementation considerations.
Required Editions
| Available in: Salesforce Classic |
|
Custom objects are available in: Contact Manager, Group, Professional, Enterprise, Performance, Unlimited, and Developer Editions Salesforce Connect external objects are available in: Developer Edition and for an extra cost in: Enterprise, Performance, and Unlimited Editions Visualforce is available in: Contact Manager, Group, Professional, Enterprise, Performance, Unlimited, and Developer Editions |
Best Practices
- The window that displays your object-level help has the same height and width dimensions as the standard Salesforce Help & Training window. To increase the usability of your help content, size and style your content appropriately.
- Your Visualforce help content pages can use merge fields or other functions to make the experience more personalized. For example, you can design the help to add the user’s name when the help page is displayed.
Advanced Implementation Considerations
- Create custom help Visualforce pages without a controller, or use a custom controller. You can’t use a standard controller.
- If you have defined object-level help for an object that you add to a Salesforce AppExchange package, Salesforce adds the Visualforce page or static resource referenced in your Context-Sensitive Help Settings for that object.
- In managed packages, object-level help is locked to the developer, giving installers the ability to change it if needed.