Instructions for translating the usersguide

Usersguide

The usersguide of SpeQ Mathematics is a chm file, Microsoft Compiled HTML Help. The usersguide is compiled using the (free) program HTML Help Workshop. This program is rather primitive, and is purely used to generate the final chm file from the html sources. The html files are created with an html editor, PSPad. The html files are also used for the online usersguide.

Translation

To make a translation of the help file, you have to do the following.

Download the English sources of the usersguide here: http://www.speqmath.com/language/usersguide/English.zip.
Open the html files (for example with PSPad editor), and translate the text in it to your language.
In the header of the html files there is a line

<meta name="keywords" content="keyword1, keyword2, keyword3, ...">
You have to translate the keywords too, but be careful: do not translate keywords that are function or variable names like Sqrt, Sin, Pi, etc.
You also have to remake the screenshots used in the html files. All images are stored in the subfolder img. This folder also contains some SpeQ files (*.spq), used to create the screenshots. Be careful that the new screenshots have more or less the same size as the old ones. If the size differs a few pixels, you have to change the width and height properties in the html files where this image is used. Most screenshots are png. To make the screenshots as small as possible, you can for example use Irfanview to save the images with as much compression as possible.
After you have finished translating the html files, you can generate the chm file.
- First run the program indexmaker5.exe (I created this program just for some automation). This program reads the keywords in all html files, and generates an index file used in the Html Help Workshop project.
- Then open the project file usersguide_project.hhp with HTML Help Workshop, and press the button to generate a chm file from it (usersguide.chm).
Rename the usersguide to the language it is written in, for example Italiano.chm or Nederlands.chm. This name should be identical to the according language file located in the subfolder language, for example Italiano.ini or Nederlands.ini (exept for the extension). In new versions of SpeQ there will be a subfolder usersguide, in which all usersguides in different languages are saved with names like English.chm. You can put the new usersguide in this folder. SpeQ will automatically use this usersguide when the according language is selected in the Settings window.

Contact

If you have any questions or suggesions, don't hesitate to email the author of SpeQ Mathematics:

Jos de Jong
info@speqmath.com

Last edited by Jos de Jong, 2008-01-17