public class

HelpHelper

extends Object
java.lang.Object
   ↳ com.microstrategy.web.app.utils.HelpHelper

Class Overview

This class attempts to ease the construction of help link in the application. All of the methods in this class are public(private) static so that it's not required to create an instance of this class.

The folder structure of help files are

  • root folder Help (microstrategy.xml)
  • admin or user folder WebUser/WebAdmin
  • DHTML or 508 folder WebHelp/508
  • Local folder Lang_localeId
  • Main help pages MicroStrategy_Web_Help.htm/MicroStrategy_Web_Administrator_Help.htm

Using user help or admi help file will follow the above folder structure. If a user wants to customize a help link that points to a self-created help page, firstly the new help page needs to be created in the root Help folder and secondly they should use the HELP_TYPE_CUSTOM or TYPE_HELP_CUSTOM_TAG and specify the full path of the help file (relative to the root folder).

Summary

Constants
String HELP_TYPE_ADMIN
String HELP_TYPE_CUSTOM
String HELP_TYPE_NONE This group of constants are used by Editor to specify the set of help file to use HELP_TYPE_NONE no help file to use HELP_TYPE_USER user help file is used HELP_TYPE_ADMIN admin help file is used HELP_TYPE_CUSTOM custom specified help file path is used
String HELP_TYPE_USER
String TYPE_HELP_ADMIN_TAG
String TYPE_HELP_CUSTOM_TAG This group of constants are used by resource tag to specify the set of help file to use TYPE_HELP_CUSTOM_TAG custom specified help file path is used TYPE_HELP_USER_TAG user help file is used TYPE_HELP_ADMIN_TAG admin help file is used
String TYPE_HELP_USER_TAG
Public Constructors
HelpHelper()
Public Methods
static String getHelpLink(boolean isCustom, boolean isUser, AppContext appContext, String helpTopic)
Generate the help file link based on the Help folder structure for User and Admin help file link = root Help folder + admin/user folder + DHTML/508 folder + locale folder + main help page + "#"+helpTopic(if any) For custom help file, take the full path (relative to the root Help folder) link = root Help folder + helpTopic
static String getHelpLink(String type, AppContext appContext, String helpTopic)
Generate the help file link based on the Help folder structure for User and Admin help file link = root Help folder + admin/user folder + DHTML/508 folder + locale folder + main help page + "#"+helpTopic(if any) For custom help file, take the full path (relative to the root Help folder) link = root Help folder + helpTopic
static void renderHelpButton(MarkupOutput out, String helpType, String helpTopic, String helpLabel, WebComponent webComponent, AppContext appContext)
static void renderHelpButton(MarkupOutput out, String helpType, String helpTopic, AppContext appContext)
This method is deprecated. use renderHelpButton(MarkupOutput, String, String, String, WebComponent, AppContext)
static void renderHelpButton(MarkupOutput out, String helpType, String helpTopic, Editor editor)
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String HELP_TYPE_ADMIN

Constant Value: "admin"

public static final String HELP_TYPE_CUSTOM

Constant Value: "help"

public static final String HELP_TYPE_NONE

This group of constants are used by Editor to specify the set of help file to use HELP_TYPE_NONE no help file to use HELP_TYPE_USER user help file is used HELP_TYPE_ADMIN admin help file is used HELP_TYPE_CUSTOM custom specified help file path is used

Constant Value: "none"

public static final String HELP_TYPE_USER

Constant Value: "user"

public static final String TYPE_HELP_ADMIN_TAG

Constant Value: "helpAdmin"

public static final String TYPE_HELP_CUSTOM_TAG

This group of constants are used by resource tag to specify the set of help file to use TYPE_HELP_CUSTOM_TAG custom specified help file path is used TYPE_HELP_USER_TAG user help file is used TYPE_HELP_ADMIN_TAG admin help file is used

Constant Value: "custom"

public static final String TYPE_HELP_USER_TAG

Constant Value: "helpUser"

Public Constructors

public HelpHelper ()

Public Methods

public static String getHelpLink (boolean isCustom, boolean isUser, AppContext appContext, String helpTopic)

Generate the help file link based on the Help folder structure for User and Admin help file link = root Help folder + admin/user folder + DHTML/508 folder + locale folder + main help page + "#"+helpTopic(if any) For custom help file, take the full path (relative to the root Help folder) link = root Help folder + helpTopic

Parameters
isCustom specify if the link is custom help or user/admin help
isUser specify if the link is user help or admin help
appContext the application context
helpTopic the topic of the help file. For user and admin the link include the helpTopic as the last part of the url prefixed with #; for custom help file the root Help folder path is pre-appened to the helpTopic as the link to the help file
Returns
  • String the url to the help file

public static String getHelpLink (String type, AppContext appContext, String helpTopic)

Generate the help file link based on the Help folder structure for User and Admin help file link = root Help folder + admin/user folder + DHTML/508 folder + locale folder + main help page + "#"+helpTopic(if any) For custom help file, take the full path (relative to the root Help folder) link = root Help folder + helpTopic

Parameters
type the type of help file to generate
appContext the application context
helpTopic the topic of the help file. For user and admin the link include the helpTopic as the last part of the url prefixed with #; for custom help file the root Help folder path is pre-appened to the helpTopic as the link to the help file
Returns
  • String the url to the help file

public static void renderHelpButton (MarkupOutput out, String helpType, String helpTopic, String helpLabel, WebComponent webComponent, AppContext appContext)

public static void renderHelpButton (MarkupOutput out, String helpType, String helpTopic, AppContext appContext)

This method is deprecated.
use renderHelpButton(MarkupOutput, String, String, String, WebComponent, AppContext)

render help button using specified help type and topic.

public static void renderHelpButton (MarkupOutput out, String helpType, String helpTopic, Editor editor)