helpman.txt

doclib\helpman.txt » Plain Format

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
                                                           2005/07/29
  HSP HELP Browser

  Copyright (C) 2001-2005 S.Programs
                                         http://sprocket.babyblue.jp/
━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━━━
        名称│HSP HELP Browser
  バージョン│1.53
    動作環境│Windows 98 / NT4.0 以降 (IA32)
──────┼────────────────────────────
    必要環境|HSP 2.61 以降
━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━━━━━

■ 概要
‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
HSP HELP Browser は、HSP 用のヘルプソースファイル (hs ファイル) の検索
と閲覧を行うプログラムです。全文検索、グループ別検索、プラグイン/モジ
ュール別検索を行うことができ、AND 検索にも対応しています。

例えば、検索キーワードに "ファイル コピー" などと入力すると、その情報
を持つページが検索結果に出てきます。

もちろん、HSP スクリプトエディタからのワンキーヘルプ機能にも対応してい
ます。



■ インストール方法 (HSP 2.61 以降の場合)
‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
既存の HSP HELP Browser (hsphelp\helpman.exe) を、新しい helpman.exe
に上書きして置き換えます。



■ 使い方
‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
HSP HELP Browser を使用するには、HSP スクリプトエディタを起動し、F1 キー
を押すか、もしくは、helpman.exe を直接起動させます。

HSP HELP Browser をはじめて起動させるときは、データベースファイル
(helpman.db) が作成されるため、操作可能になるまで多少時間がかかります。


HSP HELP Browser のウィンドウの「検索キーワード」入力ボックスには、検
索したい単語を入力します。検索にヒットするページがある場合、検索結果リ
ストにヒットするページの一覧が表示されます。検索キーワードを半角スペー
スで区切ることによって、AND 検索を行うことができます。

検索結果のリストからどれかを選択すると、選択されたページが表示されます。


検索対象とする命令グループか使用プラグインを指定したい場合は、「グルー
プ指定」か「プラグイン指定」コンボボックスから選択します。



■ メニューの説明
‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
HSP HELP Browser で、メッセージ表示部分 (上部) を右クリックするとコン
テキストメニューが表示されます。このメニューからは、以下の操作を行うこ
とができます。

・一覧に戻る [F3]
全ページ一覧へ戻ります。

・hs ファイルを開く [F8]
現在閲覧中のページ情報をもった hs ファイルを開きます。
拡張子 hs に関連付けられたアプリケーションがある場合は関連付けられたア
プリケーションで開かれ、関連付けがない場合はメモ帳 (notepad) で開きま
す。

・hs ファイル再読み込み [F5]
hs ファイルの更新をチェックし、更新があった場合はデータベースの再作成
を行います。

・画面効果 (チェックマーク付き)
画面効果 (グラデーション等) の有効/無効を切り替えます。

・常に手前に表示 (チェックマーク付き)
HSP HELP Browser のウィンドウを常に手前に表示させます。

・終了 [ESC]
HSP HELP Browser を終了します。



■ helpman.db について
‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
HSP HELP Browser は、すべての hs ファイルを統合してデータベース化した
ファイル helpman.db を作成し、使用しています。

このファイルの使用によって、検索やページの表示を高速に行うことが可能に
なっています。

データベースファイルは、それが存在しない場合と hs ファイルが追加、更新、
削除された場合に作成されます。
helpman.db には、ページ情報と hs ファイルの日付情報が含まれています。



■ hs ファイルの書式
‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
hs ファイルの書式の詳細は、同梱の HS_BIBLE.txt に記載されています。



■ アンインストール
‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
helpman.exe, helpman.ini, helpman.db を削除し、元の helpman.exe を HSP
本体のアーカイブやバックアップファイルなどから復元すればアンインストー
ルできます。



■ HTML 形式のヘルプのサポートについて
‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
HSP HELP Browser は、ヘルプディレクトリ下の html ディレクトリにある
s_xxx.htm 形式のヘルプファイルがあれば、自動的に Web ブラウザで開く機
能を持っています。
hs 形式のヘルプファイルが用意されていないプラグインなどで s_xxx.htm 形
式のヘルプファイルが用意されている場合は、html ディレクトリに置くこと
でワンキーヘルプを使用して呼び出すことができます。



■ 転載/再配布条件
‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
HSP HELP Browser の転載/再配布は、非営利目的に限り、連絡を行わずに自由
に行っていただいてかまいません。
また、不具合の解消や性能の向上のために、プログラムを書き換えて再配布を
行ってもかまいません。その場合、元のバージョンとの区別が付くよう、
ドキュメントなどに改造版である旨を明記しておいてください。



■ リリースノート
‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
1.53
・hs ファイルのエラーレポートの強化
・一部メッセージの修正

1.52
・検索キーワードによって稀に誤表示が起こる問題を解消 (1.50 からのバグ)
・db 作成時にプログレスバーを表示するようにした
・db 作成シーケンスの改良

1.51
・ページの概要表示部の色がシステムカラーに対応するように変更

1.50
・検索結果を適合度順に表示するようにした
・右クリックメニューから、以下の機能が使用できるようにした
 - hs ファイルを開く
 - hs ファイルの再読み込み
 - 機能設定
・シンボル名の重複に対応、重複シンボル名のリネームの廃止
・hs での引数の関数型表記への対応 (HS_BIBLE.txt 参照)
・hs 行頭の特殊文字 ('%', '^') のエスケープに対応 (HS_BIBLE.txt 参照)
・検索ルーチンの刷新 (適合度評価の追加、シンプル化、高速化)
・hs データベース作成ルーチンの刷新 (高速化、省メモリ化)
・hs ファイルのコンパイルログを (エラーがあれば) 表示するようにした
・メッセージボックスの左右にマージンを設定
・検索結果の概要表示方法を変更
・多数の hs ファイルを読み込むとエラーが発生するらしい問題を解消
・comctl32.dll の 4.70 (IE 3.0) 以前のバージョンへの対応を終了
・転載/配布条件変更 (改造版の配布の許可を明記など)
・HSP 2.6 用 sysval.hs の添付を終了

1.45
・データベース作成の大幅高速化
  (hs ファイル総容量が 1MB 程度の場合で従来の約 3.2 倍速)
・データベース作成時の安定性の向上
・データベース作成時のメモリ消費量の低減
・データベース化可能な総 hs ファイル容量を増加

1.43 c01
・シンボル名の偏った巨大な hs ファイルでデータが破損しないよう修正
・データベース作成の高速化ルーチンを調整
・プログラムを HSP 2.61 用に修正
・HSP 2.61 以前の環境に対応するためのコードを除去

1.41
・データベース作成を大幅に高速化 (従来の約 4 倍速)
・データベースファイルのサイズが若干小さくなるように修正

1.40
・収容キャパシティの増大 (最大 1000 ページ程度だったのを無制限に)
・ページのソートミスが発生しないよう修正
・データベースファイル作成の高速化 (従来の約 1.3 倍速)
・描画関係の内部構造の単純化
・関連項目を検索キーワードとして扱うようにした
・Windows 9x のエディットボックス容量制限に対応
・API 周りのソースの書き直し (API マクロを使用)
・「... (一覧に戻る)」機能を追加
・hs ファイルにおいて '^' タグがなくても空行を消さない仕様に変更
・hs ファイルにおいて '^p' タグを無視する仕様に変更
・ヘルプページ表示用バッファの容量調整
・その他 細かいバグ修正

1.33
・ヘルプページ表示用バッファの増加
・Windows が 256 色モードのときに問題が起こらないようにした
・色々と調整

1.32
・古いデータベースファイル hs_cache.hs を削除する機能を廃止

1.31d
・Windows 9x でウィンドウサイズが保存できていない問題を解消
・ワンキーヘルプ時にフォーカスを説明文に置くように修正
・db ファイルが若干小さくなるようにした

1.31c
・データベースファイル名変更 (hs_cache.hs -> helpman.db)
・html 形式のヘルプが存在すれば開く機能を追加
・プラグイン名加工機能を廃止
・hs 更新時刻計算の方法を変更 (ファイルシステム間の誤差に対応)
・データベースの作成を高速化 (従来の約 1.5 倍)
・hs 更新情報を ini でなくデータベースに持つようにした
・小アイコンを shell32.dll からロードしないで自前で用意した
・オブジェクトのウィンドウスタイルを調整
・4.70 以前の comctl32.dll に対応
・ウィンドウの検索フレームのリサイズに対応
・ウィンドウ状態の保存/復元方法を改善 (ウィンドウクリップ機能は削除)
・遅いマシンで検索オプションの切り替えに追従しにくくなる問題を解消
・エラー管理の強化
・バッファの増加

1.31
・ini の設定項目の調整

1.30
・hs データベース化により全文検索機能などを実装
・ウィンドウをリサイズ可能にした

1.27
・ウィンドウサイズの調整

1.25
・UI の調整
・ヘルプ情報切り出しルーチンの最適化
・バッファの増加

1.21
・HSP 2.60 の新しいプリプロセッサに対応

1.20
・キーワードの授受に共有メモリを使うようにした
・一瞬ごみが描画される問題を解消
・最小化状態で終了させた場合に起こる問題を解消
・説明文の表示を見やすくした

1.12
・ヘルプブラウザ待機時にワンキーヘルプが実行された場合に自動的にウィン
  ドウを通常化するようにした。

1.11
・関連項目内に大文字を含む命令があると誤動作する不具合を修正

1.10
・外部 DLL を不要とした。
・アイコンを作成した。
・他、細部の動作仕様を改良

1.0 (初版)


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━