No... it was designed as a proof of concept but never got our attention to develop more help topics.
Sample (modules/CRM/Contacts/help/tutorials.hlp):
[LABEL:Create new contact]
[KEYWORDS:add person]
[CONTEXT:true]
[STEPS:
hover:Menu
hover:Menu_CRM
click:Menu_CRM_Contacts
click:browse_contact->ActionBar_add
fill:rb_add_contact->#last_name // Enter last name
fill:rb_add_contact->#first_name // Enter first name
prompt:rb_add_contact->#company_name // Feel free to fill in any other information you may have
click:rb_add_contact->ActionBar_save
finish:rb_view_contact->ActionBar_edit // A new contact has been created
]
[LABEL:Search for a contact]
[KEYWORDS:find person]
[CONTEXT:true]
[STEPS:
hover:Menu
hover:Menu_CRM
click:Menu_CRM_Contacts
click?:browse_contact->#switch_search_simple
fill:browse_contact->#gb_search_field // Enter keyword here
click:browse_contact->#gb_search_button
finish:browse_contact->#gb_search_button // Results are shown in the table
]
Structure seems obvious. Every definition wrapped in brackets. Keyword separated from value by colon. Every LABEL definition starts a new help entry. Order of latter keywords doesn't matter, but I suggest to keep them as in the example.
Explanation of keywords:
LABEL - display text in help box
KEYWORDS - words used to find help entry
CONTEXT - if set to "true", "True", "TRUE", etc, then your help entry will show by default on the box. If this keyword is omitted or supplied value is other than variants of "true", then your help entry will be available only using search.
STEPS - new lines separates steps. Possible actions are: click, fill, finish, hover, prompt. After colon goes element identifier and you can put a help text after double slash //
Now the tricky part with element identifier. I'll describe in examples.
Menu, Menu_CRM, ActionBar_save - are elements identified by special html attribute "helpid". Currently only Menu and ActionBar have ones. You can find them searching for helpid in EPESI source.
rb_add_contact, rb_view_contact - are screen names and they are created by RecordBrowser module with method Base_HelpCommon::screen_name. Scheme is rb_<mode>_<recordset_name>. Every recordset will have it's screen name that you can refer.
browse_contact - similar to previous, but it's a browse mode. browse_<recordset_name>
Other examples: browse_company, rb_add_premium_salesopportunity
#gb_search_button, #last_name - are field ids defined by html attribute. If there are more than one element with specific ID, then first will be chosen.
Identifier may consist of a screen name, and other identifier, separated by '->', which means that specific identifier has to be within defined screen.
And finally:
1. help file has to be put in <module_dir>/help/tutorials.hlp
2. module has to implement help() method in common file like CRM_ContactsCommon::help.
public static function help() {
return Base_HelpCommon::retrieve_help_from_file(self::Instance()->get_type());
}
That's all I think.
Regards,
Adam
