hHelpPage

Called when the pop up help page is displayed, allowing a plugin to change the help system.

The std:minimal layout is useful for rendering replacement help pages in the correct style.

Arguments

This hook does not take any arguments.

Response

Return information by changing these properties of the response object.

Name Type Description
redirectPath String If set, the user will be redirected to this path instead of viewing the built-in help pages

JavaScript template


P.hook('hHelpPage', function(response) {
    // Respond to hook, for example
    // response.redirectPath = ...
});