Additional Options
This page contains additional options for customising Embedded Help.
Communities
Classic and Lightning Communities (such as 'Napili' and the latest templates) are fully supported:
- For classic, our 'help hooking' components can be added to the shared scripts of an entire community or particular areas / pages as desired, bringing the Quick Access Menu and / or embedded help to community users.
- For Lightning, community layouts can feature our Lightning components, much as with internally facing pages.
Visualforce Pages
You can help-enable any HTML tags in the helped Visual Force page. Typically, pages will include Apex tags for data display and/or entry, and some of these may be placed in Apex tabular page blocks to provide a user interface like standard classic pages.
Where tabular Apex form tags are used, Improved Help’s hooking mechanism recognises the rendered page markup and provide automated support of help callout positioning and sizing. As such, Improved Help behaves the same way on standard page layouts and Visual Force pages made to look and feel like standard pages.
In this way, the page developer has more flexibility over page layout and the way any Apex form tags are used:
- General HTML ‘non-Apex’ tags;
- Tabular Apex tags:
- Apex Detail tag: A full standard page in classic tabular layout;
- Apex Page Blocks: together with their enclosed, tabular Apex field tags;
- Individual non-tabular Apex tags: within more free-form page designs.
Salesforce Mobile (Salesforce1)
Setup Improved Help for Mobile (Salesforce1) All that’s needed to setup Salesforce1 Improved Help is to:
- Go to Setup > Build > Customize > Chatter > Publisher Layouts.
- Edit the Global Layout.
- Add Improved Help Action.
- Save to finish. Any Improved Help content you have created will now be available to your Salesforce1 users in the appropriate contexts.
Service Console
Provide a Quick Access Menu and embedded help for your Console users. For each Page Layout you will need to create a new button or custom link, which will reveal embedded help for the tab:
- Use a button if you would like embedded Help to appear only when users request it: they click the button to switch on Help if they wish to each time they refresh the tab.
- Use a link if you want embedded Help to appear automatically for a given layout.
Internationalisation
The Improved Help App ships with numerous custom Objects, Classes and Visualforce pages, each of which generate various on-screen labels and feedback messages. Our internationalisation features allow Orgs to provide their own translations for all of these elements (translatables) by following a single, consistent, easy to use process:
- Orgs can use our free, Excel-based translation tool (the 'Locale File Generator') to produce localisations.
- Create one copy of the tool for each desired language. The tool contains a listing of all Help translatables and can be used to show where each is used within the App.
- Each translatable appears in English, with an adjacent cell for the Org's desired translation.
- Once all translations have been entered, the tool provides the means to produce Help-ready localisation XML (a 'Locale File').
- Upload the Locale File to the Improved Help Documents folder, naming it according to the language it serves (see details later in this Reading List).
- Help will seek translations in the Locale File appropriate to the logged in User's selected language: if no suitable file has been uploaded or particular translations are missing, default (English) values are used.