Official Content

Purpose

Defines the available options when generating the application Help. The following options are common to CHM and HTML modes.

Language.  It makes it possible to generate the Help file in the languages selected (in the Location node) or in all the languages of the KB.

Object Options. It allows you to generate a help file for all the objects or only for those that were changed since the last time the Help was generated.

Include description as page title. It includes the object’s description as the title of the HTML page generated for it.

Include CSS. Name of a CSS (Cascading Style Sheet) file that is useful to change the format of the generated help file. A reference to this file is included in every HTML page generated.

Include Variables References. In the object’s HTML, it includes a link to the HTML help page of each variable in this object (when help topics have been created for this variable).

Include Attributes/Domains References. In the object’s HTML, it includes a link to the HTML help page of the attributes and domains referenced by this object (when help topics have been created for these attributes and domains).

Include Object References. In the object’s HTML, it includes a link to the HTML help page of the other objects referenced by it (when help topics have been created for these objects).

Only CHM

CHM Compiler Path. This field is disabled when generating for the Web; it must be set to generate a CHM file; otherwise, it will not be possible to move forward in the application.

Include full-text search. Besides the contents and the index, it enables the possibility to make searches in the CHM by generating a text search option in all the files that make up the help.

Custom main Html page. The Page which is displayed when the CHM file is opened. A default page is provided, but it can be customized assigning the name of the custom page to this property.

Custom content path. Like in the case of the default page, a contents file is also generated. The contents file defines a tree structure which allows organizing the items within the help.  In GeneXus, there is no way to indicate how the help items will be grouped. Thus, a rooted tree is generated by default, and all the help topics are placed bellow this root. The only embedded items are the variables with help. In this case, these items appear embedded under the help of the object where they are defined. This contents file can be edited with the HTML HELP Workshop and thus, a more organized and personalized tree will be obtained. If this file is saved with another name, it can be used in this option instead of generating the default file.

Custom index path. It is like the contents file, but for the index definition file. In the event of the index file, the  HTML HELP Workshop can be used to sort the items in alphabetical order.



Last update: February 2024 | © GeneXus. All rights reserved. GeneXus Powered by Globant