【ITニュース解説】📖 Understanding Uniface 10.4 Help Texts: A Simple Guide

Uniface 10.4におけるヘルプテキストは、アプリケーションの利用者に情報を提供する特別な機能の一つである。これは、ユーザーが操作する際に疑問に思うことや、特定の機能について知りたい場合に、詳細な説明をポップアップウィンドウ形式で表示できるように設計されている。ただし、このヘルプテキスト機能は主に以前のバージョンのUnifaceで作成されたアプリケーションとの互換性を保つために存在している点に注意が必要だ。現代のアプリケーション開発では、別のより柔軟で高機能な方法が推奨されることが多いが、既存のUnifaceプロジェクトを理解し、保守するためには、このヘルプテキストの仕組みを知ることが非常に重要となる。

ヘルプテキストを作成する手順は以下の通りだ。まずUnifaceの開発環境（IDE）を開き、「More Editors」の中から「Help Texts」を選択する。次に、作成したヘルプテキストを保存するメッセージライブラリを選定するか、新しく作成する。エディタが開いたら「New」ボタンをクリックし、新しいヘルプテキストを作成する。この際、「ヘルプ名」は非常に重要で、システム内で一意になるように設定しなければならない。既存のメッセージ名と同じ名前は使えないため、注意が必要だ。ヘルプ名に加えて、対象となる言語を選択し、任意で簡単な説明文、そして実際に表示される本文を「Text」フィールドに入力する。さらに、表示されるヘルプウィンドウの位置やサイズも細かく設定できる。具体的には、画面上のどこに（Left、Top）、どのくらいの大きさで（Width、Depth）表示するかを数値で指定できる。これらの設定により、ユーザーにとって最も分かりやすい形で情報を提供することが可能となる。

作成したヘルプテキストをアプリケーション内で表示するには、Uniface独自のプログラミング言語であるProcScriptのコマンドを使用する。主に「help」コマンドと「$text」関数が組み合わせて使われる。基本的な例では、まず$variation変数でどのメッセージライブラリを使用するかを指定し、次に$language変数で表示するテキストの言語を設定する。例えば、「myapp」というライブラリで「usa」という言語のヘルプを表示したい場合、それぞれにその値を代入する。その後、「help $text(HLP523)」のように記述する。この$text(HLP523)は、指定されたライブラリと言語の中から「HLP523」というヘルプ名を持つテキストを探し出して取得する。そして、「help」コマンドがその取得したテキストをヘルプウィンドウに表示するという流れだ。

より高度な表示方法として、ヘルプウィンドウの見た目をカスタマイズすることも可能だ。例えば、「help/noborder $text(HELPTEXT),3,4,7,23」のように記述すると、「/noborder」オプションによってウィンドウの枠線が表示されなくなり、続く4つの数字（3,4,7,23）でそれぞれ垂直位置、水平位置、垂直サイズ、水平サイズを細かく指定できる。これにより、アプリケーションのインターフェースに合わせてヘルプウィンドウを最適な位置とサイズで表示できる。さらに、現在カーソルがあるフィールドに対して動的にヘルプを表示する便利な方法も存在する。「help $text("%%$fieldname%%%_HLP")」のように記述すると、Unifaceは現在のフィールドの名前を取得し、それに「_HLP」を付加した名前のヘルプテキストを探して表示する。これにより、一つのコードで複数のフィールドに対応したコンテキスト依存のヘルプを提供できる。

ヘルプテキストを扱う上でいくつか重要な点がある。まず、先述の通り、各ヘルプテキストには必ずユニークな名前を割り当てる必要がある。メッセージとヘルプテキストは同じライブラリ内で管理されるため、メッセージの名前とも重複しないようにしなければならない。これは、電子メールアドレスが重複してはいけないのと同様に、システムがどのヘルプテキストを指しているかを明確に識別できるようにするためだ。次に、適切な言語とライブラリが正しく設定されていることを確認するのも重要である。これらはProcScriptコード内で設定することも、Unifaceの設定ファイル（アサインメントファイル）で定義することも可能だ。もしUnifaceが指定された設定でヘルプテキストを見つけられなかった場合、システムはフォールバックとして「USA」言語と「USYS」ライブラリを組み合わせて再検索を試みる。

エラーを回避するためには、ヘルプテキストを表示する前に、それが実際に存在するかどうかを確認する習慣を身につけることが推奨される。$textexist関数を使用すると、特定のヘルプ名を持つテキストが存在するかどうかを真偽値でチェックできる。例えば、「if ($textexist("HLP523")) then help $text(HLP523) endif」のように記述することで、ヘルプが存在する場合にのみ表示処理を実行し、存在しないことによるエラー発生を防ぐことができる。ヘルプテキストの作成や変更後には、必ず「File」メニューから「Save」を選択して保存する必要がある。不要になったヘルプテキストは、エディタで選択し「Edit」メニューから「Delete Help Text」を選べば削除できる。

ヘルプテキストはUniface 10.4でも利用できる機能だが、新規のアプリケーション開発においては、主に後方互換性のために残されているレガシー機能と位置づけられている。現代のアプリケーションでは、よりリッチで使いやすいユーザー体験を提供するために、ネイティブのヘルプシステム（WindowsのCHMファイルなど）、Webベースのドキュメント、UI要素にマウスカーソルを合わせたときに表示されるツールチップ、あるいはアプリケーションのコンテキストに深く統合されたヘルプ機能などが推奨されている。

結論として、Uniface 10.4のヘルプテキストは、ユーザーに情報を提供するシンプルな仕組みであり、主に既存のUnifaceアプリケーションを保守する上でその知識が不可欠である。helpコマンドと$text関数を組み合わせることで、アプリケーション内でユーザーが必要とする情報を柔軟に表示できる。ヘルプ名は一意に保ち、適切な言語とライブラリが設定されていることを確認し、エラーを避けるために存在チェックを行うことが重要だ。新しいUnifaceアプリケーションを開発する際には、現代の技術動向に合わせた代替手段を検討することも忘れてはならない。