XLsoft Corporation
English Japanese Chinese Korean


Home
SDL Trados 2007
FAQs
QA Tools
Download

HelpQA Overview

The industry standard quality assurance tool for localized RTF-based on-line help systems for Windows 95, 98, 2000 and NT.

Translating RTF files almost invariably introduces errors which can affect the functioning of the help system. Such errors include deleted and inadvertently translated footnotes, altered jumps, missing graphic references and so forth. HelpQA performs a complete consistency check across two help projects to ensure that the localized help file functions identically to the original source project.

HelpQA can also be used during the authoring process to detect many common errors such as formatting and functionality problems which are not reported by the help compiler, but which may cause display or functional errors in the final compiled help system.

HelpQA includes support for all native help-compiler source formats, including help project files (HPJ), rich text format (RTF), contents files (CNT) and the BMP, WMF, SHG and MRB graphic file formats. Its use therefore requires no changes to your localization process. HelpQA also includes full support for all single byte and double byte languages, including Japanese, Korean and Chinese (simplified and traditional).

Source Authoring

HelpQA contains a fast native C++ parser for Winhelp RTF files. This allows it to catch and report many errors, both source and runtime, which are not flagged by the help compiler.

Over 60 source errors can be triggered, including broken ALink and KLink macros, invalid characters in footnotes and macros, probably incorrect jump destinations and so on.

HelpQA uses OLE to automate Microsoft Word, so that you have instant point and click access to your project source text immediately.

Project Management

HelpQA provides one click access to full project reporting including project, per-file and per-topic word counts, graphic references and full CNT file analysis. HelpQA can output a complete report which is immediately printable and suitable to be used as the sole basis for quotation.

HelpQA uses a proprietary word-counting algorithm which is specifically designed to give accurate estimates of the number of words in Windows help source files. For comparison and compatibilty, it also reports the count Microsoft Word would give for the same project.

Engineering Verification

HelpQA verifies the functional integrity of all body text footnotes, including the topic ID (#), topic title ($), keyword (K), A-Link (A), window name (>), browse sequence (+), topic entry macro (!) and build tag (*). During the body text scan, HelpQA also ensures that all body text hyperlinks are preserved, and that the links are of the same type.

The contents (CNT) file are checked to ensure that all embedded text has been translated; that there are no missing or added directives and that the layout of the source and target files file is identical.

Finally, all matching project graphic files are scanned to ensure type-identity, matching color depth and, in the case of SHG graphic files, that the files contain identical hyperlinks.

Visual Compare

HelpQA supports a full dual Winhelp browser. This executes two instances of Winhelp and views the source help file in one, the target help file in the other. Full project random sampling is supported, as is instant access to all topics, both in the viewer and in Microsoft Word.

Version 2.0 also contains a new dual-CNT browser, a single and dual graphic browser which supports all Winhelp graphic formats, as well as an untranslated keyword index simulator.

What's new in HelpQA Version 2.1:

  • Reporting Issues (Source, Target and Compare)
  • Custom Error Reporting
  • Differentiation between \line and in paragraph counts
  • Respect order of keywords
  • Respect order of links
  • Detect table with "centering" attribute
  • Untranslated link text
  • Project Compare
  • Context Sensitive Help on Errors/Warnings
  • Downloading HelpQA


Top
Search powered by