Editing the Viewer Help and UI Data

Note: Although it is possible to edit the Viewer Help and UI data with the editor, in principle such modifications are prohibited.

When a manual is previewed or output to binary, its Viewer Help and UI data take the settings configured on the local computer.

Folder Where Viewer Help and UI Data Are Stored

The guidePage folder that contains the data for the Viewer Help and UI pages is actually a project folder for the TWL ManualEditor application.

Each language folder is in $(TWL-ManualTools_Root)\TwlManualTools\manualResources\guidePage\. Page data that sets how to use the viewers for each language and the UI exist in that directory.

Viewer Help Page and UI Page

Each language folder contains a Viewer Help page and a UI page.

$(TWL-ManualTools_Root)\TwlManualTools\manualResources\guidePage

XXX_yy \ ... Language folder (named the same as the corresponding language folder in the project)
layouts \
000guide.ntpg ...
Viewer Help page
000uitext.ntpg ... UI page

Setting Up New Viewer Help and UI Pages for Additional Languages

If you want to create Viewer Help and UI pages for newly-added languages, we recommend making a copy of a folder for an existing language and then editing the copy.

Example: To create the new language folder XXX_yy based on a copy of the existing USA_en folder:

  1. Open the folder where the Viewer Help and UI data is stored.

    Open the guidePage folder in the $(TWL-ManualTools_Root)\TwlManualTools\manualResources\ directory.

    This folder contains the existing language-specific folders for the Viewer Help and UI pages. Make sure that the USA_en folder is present.

  2. Make a copy of the USA_en folder and rename the copy XXX_yy.

    Copy the USA_en folder in the $(TWL-ManualTools_Root)\TwlManualTools\manualResources\guidePage\ directory and change the folder name to XXX_yy.

    Note: You must use three uppercase letters for the "XXX" portion of the folder name. Likewise, you must use two lowercase letters for the "yy" portion.

    Note: You must give this folder the same name as the corresponding language folder in the project.

  3. In the Manual Editor, specify guidePage as the project folder and edit the Viewer Help and UI pages.

    The Viewer Help and UI pages can be edited using ManualEditor by setting the project folder to guidePage.

Editing the Viewer Help and UI Data

By specifying guidePage as the project folder, you can edit this data just as you would edit a normal page.

Editing the Viewer Help Page

The file 000guide.ntpg is the Viewer Help page.

Use the editor to modify the text and images as you see fit, and save the file. Do not change the filename.

Editing the Viewer UI

The file 000uitex.ntpg contains the UI text for the Viewer.

Use the editor to modify the content of the text boxes and save the file. Do not change the filename.

Note: For the Viewer UI page, the only content you can change is the text that appears in the UI buttons.

Note: Although you can change the font size in the Editor, this will have no effect in the actual Viewer UI.

Note: The order of the objects in the Object Management window determines which buttons in the Viewer UI the edited text will be applied to.

The first object in the Object Management window is the Next Page button. The next two objects are the Previous Page and Close buttons. Text is applied to each button in this order.

Note: The Next Page and Previous Page buttons each have two sizes: a wide version and a narrow version. If the text box for the Previous Page button is 65 pixels or wider, the wider of the buttons is used. That said, buttons with different widths will never appear side by side. The Next Page button will be the same size as the Previous Page button, regardless of how wide its text box is.

Note: If the text does not fit inside a given button, you must adjust the wording to make it shorter.


CONFIDENTIAL