Help icons

01 help

Help icons are a simple mechanism that allows to add detailed information to every field within the system. We recommend using this kind of supporting information for business fields, e.g. statuses, stages, fields that are automatically updated, etc. Each help icon might be translated individually to every language.

Only an administrator can use this tool. When you enter Translations Management and go to the Help Icons, you will see that there are a few functionalities available. Primarily, you should select languages in which you would like to modify descriptions for icons. Then select a module and a list of available fields will be displayed. There is also an option to have a list narrowed down to fields without any description or an option to search for a specific field.  

02

It is very simple to activate a help icon. If a help icon has a description in a given language and the view is the same as the one you set, a help icon will be displayed. Please note that help icons are depended on a language so if the language of the system is different than the language of a description in a help icon, then the icon will not be displayed. If you would like to disable the display of an icon, delete its content (leave it empty).   There is a built-in editor for entering content (there are some tools for text formatting) and it is possible to use HTML. From a developer's level, it is possible to switch over to more panels with tools, but it requires changes within the code. 

03 help icon screen wysiwyg

If help icons were activated, they will be available for users in three different views that were marked next to the field: 

  • Create and edit.
  • Summary and details.
  • Quick create.
  • Thursday, 10 August 2017