Language Settings

These settings are very important for correct handling of languages and character sets in your output. Before making any changes here please study the International Languages and Unicode chapter in the Reference section carefully. For more detailed instructions for individual languages please also refer to International languages setup in the Creating Projects chapter.

Project Language:

Defines the language of the help file. This option controls sorting in the keyword index and full-text search in the published help file. In addition to this it also identifies the language to the system for proper handling of languages with special character sets and languages requiring Unicode for proper processing.

The default setting (English United States) works correctly for all Western European languages and should not be changed unless really necessary.

The language setting should be changed for Eastern European languages (including Greek and Turkish) and the Font character set setting (see below) should then be set to match.

This setting must be changed for all Asian languages and other languages requiring Unicode support (all languages with more than 255 characters that store characters as two bytes). Here too, the Font character set must also be set to match. Correct Unicode support for these languages is not possible without a correct language setting and a matching font character set setting.

Bi-di mode:

This setting is for activating support for right-to-left languages like Arabic, Hebrew and Farsi. The default is Left to Right and it should only be changed if you are working with a right-to-left language like Hebrew, Farsi or Arabic.

Right-to-left support for output formats is quite limited in Help+Manual.

The setting makes radical changes in the way Help+Manual operates, switching the direction of all the texts in the editor, TOC and everywhere else, both in Help+Manual itself and in the published output.

Font charset:

Defines the character set to be used both in your published help file and in the Help+Manual editor.

The default setting (ANSI_CHARSET) should be used for English and all other Western European languages.

This option must be set to the correct, specific character set for all Eastern European languages (including Greek and Turkish). Furthermore, this setting must match the Language of the help file setting.

This option must also be set to the correct, specific character set for all languages requiring Unicode support (most Asian languages and other languages with more than 255 characters). In these languages too it is essential to set both this option and the help file language option to the correct, matching settings for the language you are using.

Title, Version and other settings

Help title:

The title of your help project. The text you enter here can be inserted anywhere in your project with the <%TITLE%> variable.

For example, in HTML Help you can display it in the title bar of the help viewers by inserting the <%TITLE%> variable in the Title bar text: field for the Main help window definition in the Help Windows section (this is the default setting).

In WebHelp this text is inserted in the title bar of the web browser by using the <%TITLE%> variable in the <title> tag of the frameset file in the Layout section (this is the default setting).

Author:

The author of your help project. This text is not used automatically by Help+Manual. You can insert it yourself anywhere in your project with the <%AUTHOR%> variable.

Summary:

A short text describing your project. This text is not used automatically by Help+Manual. You can insert it yourself anywhere in your project with the <%SUMMARY%> variable.

Copyright:

The copyright notice for your project. This text is not used automatically by Help+Manual. You can insert it yourself anywhere in your project with the <%COPYRIGHT%> variable.

Comment:

Space for a comment about your project. This text is for internal information and documentation only. There is no corresponding variable so you cannot insert it in topics in your project.

Major Version:
Minor Version:
Build Version:

These fields have four corresponding variables that can be used to generate three-part version numbers.

The variables corresponding to the individual components are <%VERSION_MAJOR%>, <%VERSION_MINOR%> and <%VERSION_BUILD%>.

The fourth variable, <\%VERSION%>, combines the contents of the three fields with dots between them, like this:

6.5.456

Default ("Home") topic:

This setting specifies the topic that is automatically displayed when an electronic help file is opened (HTML Help, WebHelp, eWriter Help). This setting is not supported in ePub eBooks.

See Setting the default topic for full details on setting and using the default topic in different contexts.

You can also use a user-defined variable in this setting to insert the topic ID of the default topic. Just type the variable name into the Default Topic field using the standard <%VARIABLE_NAME%> syntax. This makes it possible to define the default topic dynamically by changing the definition of the variable when you publish.

Note on Home topic and CHM publishing:
When you are working in Help+Manual and publish a CHM it will try to display with the topic you are currently working on, not with the Home topic. This won't affect the CHM when it is opened directly or by your application, it is just a convenience for use when you are testing while working with Help+Manual.

See also:

Creating Projects

Using Variables