Creating a user macro help file for keywords

You can use the Remote C/C++ Editor to access custom help that you create for use with the product. You can create a user macro help file that maps selected keywords (such as method and class names) to specific help pages. This mapping specifies which online help page opens when you select a keyword and press F1.

To create a user macro help file, complete the following steps:

1. Using a text editor such as LPEX, create a file to store the mapping between keywords and online help files.
2. For each keyword that you want to map to an online help page, type the mapping between the keyword and the help page that you want to open when you select the keyword and press F1.
   Use the following format:

   keyword=help_path

   keyword

   The keyword that you want to map to an online help page, such as char. The help is case-sensitive. Specify the keyword in the same case that you want to search for.

   help_path

   The help page that you want to open for the selected keyword. You must specify the help path in the following format:

   /plugin_name/path/file_name

   You must specify the forward slash (/) before the plug-in name, for example:

   /com.ibm.uss.projects.doc/langref_os390/cbclr21009.htm

   If the help page that you want to map to is an external page, use the following format:

   http://<url>

   For example:

   http://www.companyxyz.com/software/macros.htm

   The resulting line is displayed as shown in the following example:

   char=/com.ibm.uss.projects.doc/langref_os390/cbclr21009.htm

3. Save and close the file.
4. In the User Macro F1 Help Files section of the CPP tab of the Editor Options preference page, add the name of your user macro help file to the list.
   For more information about setting CPP options, see the related topics.