Skip to content

Files

Latest commit

e5231fd · Apr 3, 2025

History

History

Manual

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Apr 3, 2025
Mar 23, 2025
Apr 3, 2025
Oct 1, 2019
Jan 20, 2020
Mar 13, 2025
Mar 15, 2025
Mar 13, 2025
Aug 26, 2023
Mar 15, 2025
Mar 20, 2025
Mar 20, 2025
Mar 20, 2025
Mar 20, 2025
Mar 20, 2025
Mar 20, 2025
Mar 20, 2025
Sep 15, 2019
Mar 23, 2025

User Manuals in DocBook/XML

Our Manuals are written in DocBook and we generate HTML and CHM manuals for distributing.

We have currently manuals in the following languages:

Useful DocBook resources

Editing the manual

The user's manual is XML, so you can use XML editor or your favourite text editor.

Note that XML requires document to be well formed, unlike HTML, before it can be processed.

See these tutorials for editing DocBook:

Important files

  • {LANG}\_Copyrights.xml Update copyright information’s
  • {LANG}\_VersionNumbers.xml Update WinMerge version number and Manual revision
  • {LANG}\xsl\html.xsl Update WinMerge version number at parameter headtitle.suffix

Translating the manual

The translation of the manual is managed using PO files, similar to the WinMerge program. We use po4a for extracting the translatable text from the English XML files and applying the translations back to the translated XML files. To update the various translation-related files after editing the English XML files or PO files, please install po4a.

Installing po4a

Install MSYS2 in C:\msys64 or D:\msys64, and in the launched terminal, install po4a and diffutils as follows:

pacman -S po4a diffutils

Building the manual

Our preferred build system uses the following tools:

The easiest way is to download our manual build tools package v2. The package contains required tools for manual building.

Installing the tools is easy - just unzip the tools package to folder \Docs\Manual\Tools.

Batch files

The batch files are located at the \Docs\Manual folder.

Every language has his one batch files. Paths to the installed tools are written in the configuration.bat file.

  • build_html_en.bat
    Creates the English HTML files without ads under the folder \Build\Manual\html-en.

  • build_html_en.bat withads
    Creates the English HTML files with ads under the folder \Build\Manual\html-en.

  • build_htmlhelp_en.bat
    Creates the English CHM file under the folder Build\Manual\htmlhelp.

  • update_translations.bat
    Extract translatable text from English XML files and apply translations back to the translated XML files.

The Japanese batch files ends with _jp for example.