Online help for users is realized by providing CHM files and ZIP files. How to display and provide them is outlined in the next few chapters.
Using Online Help
Links to online help themes can be displayed by clicking the button . This button can be found on every portal pane in the right upper corner.
The help area is divided into two parts. Inside the border links to HTML files (included in CHM files or included in ZIP files) can be provided. This area is used to point out important topics. Outside the border links to CHM and ZIP files are provided.
How to Create a Help Area
- Each help area belongs to an application view. The first thing to do is to localize the appropriate application view where the help text should be displayed. For example if online help should be displayed on the ”Classic” portal pane then the right choice is FSCVENV@1.1001:ExploreAppView.
Note: Compare the name of the application view to the heading displayed on the page. The heading on the “Classic” portal pane is dynamic. It displays the object class and the name of the object. So the name of the application view must be something like this: <%currobjclass%> "<%currobjname%>"
Very important: Use the software component that the application view belongs to as prerequisite and extended component in the XYHelp software component.
- Edit the properties of the appropriate application view and click the “Application View (Advanced)” tab.
- In the Explanation Texts field a new line must be created. Select “Details” in the Explanation Text Types field and choose the XYHelp software component in the Software Component field.
The Explanation Text property represents the text and links in the help area. Creating a new entry in this field, it is possible to provide different help content for different languages. Help content is only displayed if the language of the user environment matches the language of the help content. The help content has to be created in the file system and imported in the language-specific content afterwards. It has to be encoded in UTF-8 and correspond to the following example:
<?xml version="1.0" encoding="UTF-8"?>
<table width="100%" border="0">
<th align="left" colspan="3" style="font:medium">
<td align="left" valign="top" height="10">
<td align="left" valign="top" height="10">
The HTML text between the outer <table> tags may be modified. The first <td> tag contains Fabi the fish. The <th> tag represents the heading. Below the heading are two columns with a link in each column.
Save the text file in UTF-8 and import it in the Explanation Text field. The result for this example looks like:
Note: Immediately after the change the result can only be seen if an iisreset is performed. Reason: Component objects like virtual applications are cached and an iisreset forces a renewal of the cache.
- Until now the links do not work because the CHM file that is linked must be provided in the software component for the online help. Edit the properties of the XYHelp software component. On the “Software Component” tab in the Contents field the CHM file XYHelp.chm and the ZIP file XYHelp.zip must be provided. Therefore create two entries in the Contents field. The Base Name field has to start with the string “help:” followed by the name of the file. Select the correct language, choose “Help File” as Content Type, import the CHM file or the ZIP file as Content and specify the extension as “chm” or “zip” respectively.
- The HTML files included in the CHM file can be referenced by their names, for example TheDesk.htm. A link to that page in the XYHelp.chm looks like:
<a onclick="return vapphelp('XYHELP.chm::/TheDesk.htm')" href="#">The Desk</a>
CHM files and ZIP files as whole files can also be linked in the help area. The following steps are necessary to do this.
- Edit the properties of the software component. The links to CHM files are specified on the “Online Help” tab in the Specific Help Files field. Create a new line. In Detail the object is specified where the link to the help file should be displayed (e.g. if you specify FSCVENV@1.1001:ExploreAppView, the link would only appear in this application view). If the field is empty the link appears in forms and portal pages. In Help File insert the name of the help file. The Help Title specifies the text of the link.
Note: There has to be a file named index.htm in the ZIP file, so that browsing the help contents is possible. Typically this is the root file of the help contents.
An iisreset is necessary to display the links in the Fabasoft Folio Web Client.