Using The Help System

mojoPortal includes a simple but flexible help system that you can easily use in custom feature development.

In your custom controls or pages you can declare a help link like this:

<portal:mojoHelpLink ID="MojoHelpLink1" runat="server" HelpKey="what-your-help-is-about-help" />

The help key is a unique identifier for your help topic, it should not have any special characters or spaces in it because the help key is used as part of the file name for the help file.

Help files are stored under /Data/HelpFiles and are localized with language prefixes, the language prefix is determined by what culture the thread is executing as. Depending on configuration it may be determined by the browser language preference or it may be forced to a specific culture for the site. So the English help files are prefixed with en-US-, so in the above example the file would be named

en-US-what-is-your-help-about-help.config

and the Italian version would be it-IT-what-is-your-help-about-help.config

if there is no file for the current language it will fall back to English. If there is no English file it will show a generic message that no help is available for this topic.

When you click the help link, if you are an administrator or content administrator by roles, then you can edit the help file. So you basically add your links and then click them to edit the help and it will create the help file.

You can also add help for Feature Settings aka Module Settings which are shown on the ModuleSettings.aspx page. By specifying a helpkey on your settings in your feature definition file, it will automatically add help links.

Last Updated 2011-05-20 by Joe Audette