Three simple steps to localize
The German and French Online-Help pages have been created with the help of machine translation. In doubt please read the English original.
Use this sheet configure how help file is localized.
Specifies how HTML data is localized. Possible values are:
|Scan images||If checked Sisulizer scans images of the HTML files making it possible to replace them in the localized files.|
|Update image sizes||If checked Sisulizer updates the image size attributes to match the localized image (if any) when writing the localized HTML files.|
|Update sizes in image styles||
If checked Sisulizer updates the image size values in style attributes to match the localized image (if any) when writing the localized HTML files.
For example the size of the original image is 200x100 and the translated image is 210x110.
|Keep format||If checked the text preserves spaces and line breaks. Otherwise all extra spaces and all line breaks will be removed on scanned rows.|
|Keep format in code tags||If checked the text enclosed in the code element preserves spaces and line breaks. Otherwise all extra spaces and all line breaks will be removed on scanned rows.|
Specifies HTML Help options and what other HTML Help items in addition of HTML data is localized. Possible values are:
|Scan contents||If checked Sisulizer localizes contents data (.hhc file).|
|Scan index||If checked Sisulizer localizes index data (.hhk file).|
|Scan browse sequence||If checked Sisulizer localizes browse sequence data (.brs file). Some help authoring tools can add browse sequence elements into CHM file.|
|Scan script||If checked Sisulizer localizes script files (e.g .js file).|
|Create localized CHM file||If checked Sisulizer creates localized CHM file.
If unchecked Sisulizer creates localized HTML files. The user has to use HTML Help Compiler to compile localized HTML files into localized CHM file.
|Group items||If checked contents, index, browse sequence, and browser nodes are grouped in Items folder in the project tree.
If unchecked above nodes are placed in the root node of the source.
|Use compatible language id whenever possible||If checked Sisulizer uses compatible language id when creating localized CHM file. This means that if the target language is not English but uses Western code page 1252 such as German or French, Sisulizer sets the language id of the CHM to English (United States),
|Use compatible index||If checked and original CHM file uses binary index then Sisulizer creates binary index to localized CHM files only if the code page of the target CHM and the current system match.If code pages do not match then the localized CHM file does not use binary index. This option is because HTML Help compiler can not create correct index data if there is no code page match. Learn more about this.
|Include images in the Files section||If checked Sisulizer add images files in the Files section of the project file (.hhp) of the localized CHM file. Check this if the localized CHM files do not include all images files.
Specifies if the table of contents (TOC) will be sorted. Possible sorting methods are:
|Do not sort
||Table of contents is not sorted|
|Sort pages first, then sub folders||Table of contents is sorted such way that it first contains pages and then sub folders.|
|Sort pages and sub folders together||Table of contents is sorted such way that pages and sub folders are sorted together and they may be pages between folders.|
Top level sorting specifies how top level items in the contents are sorted. Sub level sorting specifies how sub level items are sorted.
Note! When you turn on sorting Sisulizer visual contents editor still shows the contents as unsorted. However when you build localized files the contents is sorted using the sort method you selected.
If checked table of contents is sorted alphabetically. This means that if original file contains a sub folder having single character as its name all the sub pages will be placed on sub folders where the name of the folder matched the first characters of the page name.
Note! This option is used only when you localize to a language that uses alphabets. If you have Chinese, Korean or Japanese in your project the contents file this options is ignored for those languages.
The following image contain original non sorted table of contents.
The following image contain sorted table of contents where Sort pages first, then sub folders sorting is used.
The following image contain sorted table of contents where Sort pages and sub folders together sorting is used.
The following image contain original non sorted table of contents that contains alphabet based sub folders. The name of the each sub folder is only one character. Each sub folder contains pages that start with the same name as the folder name.
The following image contain Finnish version of above table of contents.
You can see that there are now four sub folders instead of original three. This is because in Finnish all three vehicles start with different letter. In English both bike and bicycle start with b.
Use this sheet to control what strings are scanned from the files and how they are scanned. Tags are used to control the scan process. They are single line comments that contain information for Sisulizer scanner.
Specifies how tags are used when localizing. Possible values are:
|Localize all but excluded||Sisulizer localizes all strings except those that have an exclude tag. You can also use information/include tags to give some properties such as comments and maximum lengths.|
|Localize only included||Sisulizer localizes only those strings that have an include tag.|
There are two kind of tags. They are:
Information/include tag is used to pass string properties to the project. The syntax is
<comment><tag>[comment string|attribute]... attribute=MaxChars=mc|MaxPixels=mp|Expression="expression"
where comment is the single line comment character (e.g. "//"), tag is a tag string (e.g. slz), mc is the maximum length of the translation in characters, mp is the maximum length of the translation is pixels, and expression is the combined string expression.
The following line has an include tag that makes Sisulizer to scan the string.:
str = "Hello world"; //slz
The following line has an information tag that contains a comment ("Clicking this button opens on-line help") and sets the maximum length to 300 pixels:
str = "Click Help to get more information"; //slz MaxPixels=300 Clicking this button opens on-line help
Following parts are enabled when the Tags usage is set to Localize all but excluded.
If you want to disable localization of a string, add an exclude tag on the same line where the string is located. The syntax is
For example the following line contains SQL statement and it should not be localized. To disable its localization an exclude tag has been added:
str = "SELECT * FROM MyTable"; //noslz
You can disable localization of a entire source code block by using begin and end exclude tags. These will disable all lines between these two tags. The syntax is
For example the string in the following two lines are not localized.
str1 = "Do not localize this";
str2 = "Do not localize this either";