Overview

qHelpLink provides a context-sensitive help functionality. The help link enables each page to be connected to a different help file or to no help file (in which case the help link will not be visible). This capability lets the site administrator or author issue the help files in stages.

The help link information is stored in a SharePoint list. The SharePoint list for the help link should contain:

•	Context ID — This field is mandatory. This is a single line of text that contains the identifier for the help URL.

•	Help Url — This field is mandatory. This is a single line of text that contains the URL for the help file.

•	Culture — This field is optional. You must have this field if you want to have a different Help URL for different culture. You can define different Help URLs with the same Caption ID but different Help URL. You must leave the value for the default culture blank. For example:

 

 

Table 1. Culture

Context ID	Culture	Help Url
sites.mysite.default.aspx		defaultHelp.aspx
sites.mysite.default.aspx	id-ID	defaultHelp.id-ID.aspx

If your list uses different names for the fields, you must define the name in the Context ID Field Name, Help Url Field Name, and Culture Field Name properties.

The Help URL field may contain an absolute or a relative URL.

You can create the source list easily by using the “AgreeYa Help List” under Custom Lists in SharePoint. This will automatically create a list that contains all of the above fields.