cms_help

We need your assistance to make the documentation accurate, user friendly and understandable. Therefore we welcome any tips or suggestions regarding documentation. Thank you in advance for your contribution.

However, we will not respond to technical support questions submitted using this form. If you are having difficulty with CMSMS and cannot find the solution on this website, please submit your question appropriately on our support forum at: http://forum.cmsmadesimple.org. Please remember to follow the forum rules when posting.

CMS Made Simple™ Partner



   Purpose

This is an admin only plugin to use to generate a link that when clicked will generate popup help for a particular item.

This plugin is typically used from module admin templates to display end user help in a popup window for an input field, column, or other important information.

   Parameters

  • key - (required string) - The second part in a unique key to identify the help string to display. This is usually the key from the appropriate realms lang file.
  • realm - (optional string) - The first part in a unique key to identify the help string. If this parameter is not specified, and this plugin is called from within a module action then the current module name is used. If no module name can be found then "help" is used as the lang realm.
  • title - (optional string) - Help box title
  • assign - (optional string) - Assign the output to the named smarty variable.

   Example

{cms_help key2='help_field_username' title=$foo}