Unicode Support

Unicode Support

Overview as of DBDOC 10.6.1

There is extensive support for Unicode characters in Hyperview. Support can be summarized in each of three main areas:

  1. Graphical documents (operator graphics, CAD/CLDs etc.)
  2. Text documents (indexes, reports, database pages etc.)
  3. Tools (Audit Window, bookmarks, Watch Window etc.)

"Regular" vs "international" version of DBDOC

There are two versions of DBDOC 10.6.1: the "regular" version, and the "international" version. Only the "international" version supports Unicode characters on text documents. However, this support is under development, so for users who do not require Unicode characters, it is better for now to use the "regular" version of DBDOC, which supports Unicode characters everywhere except on text documents. When Unicode text document support becomes sufficiently stable, the "international" version (in a later update of DBDOC) will become the main version of DBDOC.

Unicode support in different areas

Unicode support on graphical documents

Unicode characters are supported on graphical documents (which include CADs, CLDs, graphics, AutoCAD drawings, or any other non-text-based document) in both the regular and international version. Unicode characters can appear in tagname labels, descriptive text, titles etc. The Unicode characters can be copied or searched for via the context menu.

Unicode support on text documents

RTF vs HTML text display

The support for Unicode characters on text documents is a little more complicated. Text documents are common in Hyperview. All the indexes (the Table of Contents, every Block Index, the Tag Index etc) are text documents. Most of the reports generated by the build are also text documents (Significant Change Report, Undefined Tags, Missing Graphics etc). And finally, all the database pages are text documents.

The regular version, as it always has, uses an underlying RTF component to display text documents. Unfortunately, this legacy component does not support Unicode characters. The international version instead uses an HTML component to display text documents. Unicode characters are handled nicely, but fully porting all functionality to this new component is an ongoing process, and is current at a beta level of support.

The upshot is, that for now, it is best to use the regular version of DBDOC, unless you have a strong need for Unicode character support (which some systems do), in which case the trade-off with beta-level text document functionality is probably acceptable.

How to switch between HTML and RTF

Note that you can only switch into HTML Mode when running the "international" version of Hyperview.

  • On the View menu, click HTML Mode. This toggles HTML and RTF.
  • Or, press F7.

Known issues in HTML Mode (beta)

There are variety of known issues in HTML Mode, which should mostly be sorted out in the next version of DBDOC. Some that you might encounter are listed below.

  • Loading of very large documents (mainly the Table of Contents, and to a lesser extent, the Tag Database) is slow. It may take a few seconds.
  • Minor issues exist with respect to the scrolling and refreshing of annotations.
  • Minor issues exist with respect to history (Back button) when HTML Mode and RTF Mode are mixed.
  • Annotations on HTML documents do not print.
  • Hotspots on HTML documents do not highlight.
  • Synchronize with Table of Contents is unimplemented.
  • Searching largely works, but the search result is not explicitly highlighted.

Unicode support in Hyperview tools

In general, Unicode characters are well supported across Hyperview tools.

  • Searching: Searching largely works, but the search result is not explicitly highlighted.
  • Error Browser: Unicode characters are supported in the Error Browser.
  • Bookmarks: Bookmarks descriptions can use Unicode characters.
  • Audit Window: The Audit Window can contain Unicode characters.
  • Watch Window: Watch Window block descriptions can contain Unicode characters. They display improperly when drawn on the plot.
  • Annotations: Unicode characters can be used in text annotations, and in live loop annotation descriptions.