If you know HTML, it’s easy to add help to your custom objects by writing the content in HTML and saving it in a Visualforce page. No need to learn Visualforce. Just use the template that we provide.
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 |
| User Permissions Needed | |
|---|---|
| To define or change object-level help: | Customize Application |
| To create or edit Visualforce pages: | Customize Application |
- From Setup, enter Visualforce Pages in the Quick Find box, then select Visualforce Pages.
-
Click New.
The Visualforce page editor opens with a new page.
-
Complete the following fields.
Field Description Label The human-friendly name of the page used to identify the page in Setup tools. It’s a great idea to have a naming convention for your custom help pages. For example, start all custom help pages with “Help_” and then the object name. Name The API name for the page. You can use the auto-filled value. Description An optional description of the page. Available for Lightning Experience, Experience Builder sites, and the mobile app Select this option if your custom object is available in the Salesforce mobile app. - Click Quick Save.
- In the Visualforce Markup tab code editor, select the default code and delete it.
-
Paste the following help template code into the code editor.
<apex:page showHeader="false"> <!-- Add your help styles --> <h1>Help for {YourObjectName} Object</h1> <p>Your custom help message here.</p> </apex:page> - Click Quick Save.
-
Edit the template to add your help content.
To add formatting to your page, use HTML markup. You can also use Visualforce markup if you know it.
- Click Save.
You can now add this page as custom help. When users click Help for this Page, they see this page in the Help & Training window.