More ...
HSP2.61:hsphelp
- →HSP2.6:付属文書に戻る
------------------------------------------------------------------------------ HSP HELP Tools for 2.61 USERS MANUAL HSP : Hot Soup Processor ＨＳＰヘルプツール・マニュアル copyright 2004 (c) onion software ------------------------------------------------------------------------------
・はじめに
HSP HELP Toolsは、Hot Soup Processor ver2.61で使われるヘルプ表示 システム関連のツールの総称です。 HSPで使われているヘルプやリファレンスのカスタマイズ、追加変更を 行なう場合に使用してください。 マニュアルの不備や、説明が足りない部分もあるかと思いますがご了承下さい。 このバージョンについてお気づきのことや、ご意見などありましたら、 メールや掲示板の方にお寄せ下さい。
命令ヘルプの作成にあたり、yoshisさん、nakaさん、tomさん、Sinagawaさんに ご協力いただきました。 その他、ご意見やテストをしていただいたユーザーの方々に感謝致します。
・動作環境
HSPヘルプ関連ツールは、HSPが動作する環境(Windows9x/NT/2000/XP)で動作します。 すべてのツールは、HSPによって作成されています。
HSPヘルプで使用されるデータファイルは、HSPヘルプデータ(拡張子がHS) と、「HSPHELP.IDX」というファイル名のヘルプ検索インデックスデータに なります。「HSPHELP.IDX」は、同じディレクトリにあるすべてのHSPヘルプ データをもとにMKINDEX.EXEが作成します。
HSPヘルプ関連ツールとして使用できるプログラムは以下の通りです。
・MKINDEX.AS HSPヘルプ再構築ツール
HSPヘルプデータ(HS)のデータをもとに、インデックスデータを 再構築したり、htmlファイルを生成するためのツールです。 ヘルプデータの更新をしたい場合に使用します。 hspext.dllおよびhspda.dllが必要です。
・HELPMAN.AS HSPヘルプマネージャ(ビューア)
HSPヘルプデータ(HS)のデータを検索、閲覧するためのツール です。このヘルプマネージャは、ver2.6まで使用されていた旧版で、 ver2.61からS.Programsさん作成の「HSP HELP Browser」が、 標準で使用されるように変更されています。
・HS_WRITE.AS HSPヘルプ記述ツール
HSPヘルプデータ(HS)のデータを作成するためのエディタです。 データの追加、更新、削除をすることが可能です。 また、従来のhtmlで書かれたヘルプをHSPヘルプデータに変換する 機能も持っています。 このツールは、ソースのみ付属しています。実行のためには、 HSPスクリプトエディタで読み込んで実行してください。
以上のツールは、すべてHSPのソースとして提供されています。 HSPフルセットのインストールディレクトリ以下にある「hsphelp/source」 に置かれています。スクリプトエディタで読み込んで適宜お使い下さい。
・HSPヘルプシステムについて
HSPヘルプデータは、HSP ver2.55以降から正式にサポートされている独自 形式のヘルプ記述ファイルです。 いままでHSPで使用してきたhtmlによるヘルプは、他の形式への変換が難し く、また記述にも手間がかかるなどの問題がありました。 HSPヘルプデータを使うことで、html形式はもちろん、他の形式への変換 も容易になり、データ形式やモジュールを公開することでユーザー自身が データの変換や、ビューアーの作成を行なうことができるようになります。
また、外部拡張プラグイン(DLL)の命令などによる命令の追加を行なった 場合でも、索引も含めて簡単にヘルプ表示を更新することができます。
ver2.5までで使用されていた、従来型のhtml形式ヘルプに変換して使用 することも可能です。 HSP HELP Toolsでは、ヘルプ作成のルールを一元的に管理して、便利に 使えるようにしたものです。ユーザーは、ヘルプ形式を好きに選んで いただいて構いません。
・ヘルプマネージャとは?
HSPヘルプマネージャは、HSPの命令ヘルプを見るためのツールです。 ver2.61から、S.Programsさん作成の「HSP HELP Browser」が同梱されて います。 ver2.5までのhtml形式ヘルプと比べて、ヘルプの一括管理ができ、ユーザーが 独自に記述・拡張することが可能、htmlブラウザに左右されない高速性と 安定性、全文検索やキーワード検索機能などの特長を持っています。
・ヘルプマネージャの使い方
HSPスクリプトエディタから使用する場合は、「ヘルプ」メニューの 「HSPヘルプ設定...」ダイアログで、ヘルプの種類を「HSPヘルプマネージャ」 に設定してください。さらに、必要に応じてヘルプデータの場所を下の 入力枠に指定してください。(例:「C:\HSP26\HSPHELP」) ヘルプデータの場所が空欄の場合は、HSPスクリプトエディタのある場所に ある「hsphelp」フォルダが参照されます。通常は、このデフォルト設定で 問題ありません。 以降は、通常のワンキーヘルプ(F1キー)でヘルプマネージャを呼び出す ことが可能です。
HSPヘルプマネージャを単体で起動すると、検索キーワードを入力する 入力ボックスが現われます。ここに、検索したい命令またはキーワードを 入力して、[help表示]ボタンを押すか、[Enter]キーを押すことでその内容 に応じたヘルプが表示されます。以上が基本的な使い方です。
HSP HELP Browserについての詳細は、「helpman.txt」を参照してください。 全文検索、グループ別、プラグイン別検索など多彩な機能を持っています。
・ヘルプ表示データの更新
もしあなたが、ヘルプのデータを新しくダウンロードするなどして、 追加のヘルプデータを入手した場合には、ヘルプのあるディレクトリ (HSP HELP Browserのあるディレクトリ。通常は、hsphelp以下。) にコピーして下さい。自動的にキーワードに加えられ、検索の対象となります。
・HSPヘルプマネージャ画面
HSPヘルプマネージャ(旧版)の画面説明を行ないます。 最新版のビューアー(HSP HELP Browser)についての詳細は、「helpman.txt」を 参照してください。
ヘルプ表示画面には、以下の項目が表示されます。
-------------------------- | (1) [(2)] | |------------------------| | (3) S I R | | [閉じる] | |------------------------| | (4) | | | | | | | |------------------------| | (5) | --------------------------
1. ヘルプキーワード
表示されている内容を示すキーワードが表示されます。 通常は命令の名前になっています。
2. ヘルプタイトル
表示されているヘルプの見出しとなります。 命令の内容を簡単に表わす言葉になっていることが多いです。
3. パラメータ表示
命令のパラメータについての詳細情報を表示します。 また、外部拡張命令であれば必要な外部DLLを表示します。 パラメータ表示の右側には、いくつかのボタンが表示されます。 [閉じる]ボタンは、ウインドゥを閉じ、ヘルプを終了します。 [R]ボタンは、ふたたびヘルプ検索キーワード入力を行ないます。 [I]ボタンは、表示中のヘルプに関する追加情報を表示します。 [S]ボタンは、表示中のヘルプに添付されたサンプルスクリプト などの情報を別ウインドゥに表示します。添付されている 情報がない時は、このボタンは表示されません。
4. ヘルプ内容
ヘルプの本文が表示されます。 このウインドゥはメッセージボックスと同じように、カーソルを 動かして内容をスクロールさせたりコピー、カット&ペースト などの編集を行なうことが可能です。(内容を編集しても、もとの ヘルプデータは変更されません)
5. 関連項目
表示されたヘルプに関連する項目がある場合は、「関連○項目」 と表示されます。このコンボボックスを開くと、関連項目の リストが表示され、直接選ぶことができます。
HSPヘルプマネージャでは、必要な項目を高速に検索するためにインデックス ファイルというデータを使用しています。 これは、"hsphelp.idx"というファイル名でHELPMAN.EXEと同じディレクトリに 存在していなければなりません。
・mkindex.exeの使用方法
このツールでは、HSPヘルプデータを統合した管理を行ないます。 主な機能は以下の通りです。
・index作成
hsphelp.idxファイルを作成します。 このファイルは、すべてのHSファイルの内容をまとめたもので キーワード検索などに使われます。HSデータの内容を更新した 場合には、hsphelp.idxも更新が必要です。 hsphelp.idxは、HSPヘルプマネージャ(HELPMAN.EXE)などで使われ ます。
・keyword表示
インデックス一覧(左上のリストボックス)の中から選んだ キーワードの内容を簡単に表示します。内容チェックのために 使います。
・html作成
作成したhsphelp.idxをもとに、すべてのヘルプデータを html形式に変換します。 ファイルは、MKINDEX.EXEの下にあるhtmlディレクトリに作成 されます。また、索引(hsppidx.htm)と一覧(hspref.htm)も 同時に作成されます。
・text作成
作成したhsphelp.idxをもとに、すべてのヘルプデータを 1ファイルのテキスト形式に変換します。 ファイルは、MKINDEX.EXEと同じディレクトリにhelp_all.txt という名前で作成されます。
・hs_write.asについて
HS_WRITEツールでは、HSPヘルプデータ(HSデータ)の内容を編集することが できます。HSデータは、１つのファイルに複数のヘルプ情報を保存することが できるテキスト形式のファイルです。 HSデータには、次の情報が複数保存されます。
%index (検索キー)
ヘルプ項目のキーワードとなります。 これは通常、命令の名前そのもの(picloadやbufferなど)が使われ ます。
%index2 見出し
ヘルプ項目の見出しになる部分です。 この項目を簡単に説明したものになります。
%group (グループ)
命令が属するグループです。 いくつかの選択肢から選ぶことができます。
%prm (パラメータ)
命令が取るパラメータと、その説明を書きます。 １行目にパラメータリスト、たとえば「str p1,p2」という 命令であれば、「p1,p2」の部分を記述します。 ２行目以降に、各パラメータについての説明を記述します。
%inst (説明)
命令についての説明本文です。 １行が長くなる時は適度に改行をしてください。 特殊な制御コードとして、 「^」を入れると、１行改行します。(普通に何もない行は 改行にはなりません) 「^p」を入れると、以降を等幅で段を下げた状態にします。 ふたたび「^p」が現われると解除されます。 また、「^」以降に「<…>」のようなhtmlタグを入れると、 htmlに変換した時のみ有効になります。
%sample (サンプルスクリプト)
命令に関するサンプルスクリプトがある場合に、分けて 置いておくことが可能です。
%href (参照)
内容に関連したキーワードを記述します。 対になる命令や、参照すべき命令などのキーワードを書いて おくことで、リンクを張ることができます。
1つのHSファイルには共通の詳細情報が保存されています。
%type (命令タイプ)
ファイルに含まれている命令のおおまかな区分けをします。
%ver (HSデータのバージョン)
HSデータのパージョン情報を記述します。
%date (HSデータの作成日)
HSデータの作成日を記述します。
%author (HSデータの作成者)
HSデータの作成者を記述します。 作成者が複数の場合は、行を分けて記述します。
%dll/add (必要な外部DLL)
外部DLLが必要な場合は、その名前(拡張なし)を記述します。
%url (参照するURL)
内容に関連したURLなどを記述します。
%note (補足)
HSデータに関する補足事項を記述します。
HSデータ自体は、テキストファイルで「%タグ」の後に情報が続いている 単純な形式になっています。 HS_WRITEツールを使わずに通常のテキストエディタで編集することも可能です。
・HS_WRITEツール使用方法
メインウインドゥにある、それぞれの入力ボックスにヘルプの内容が表示 されており、編集することができます。 HS_WRITEでは、基本的にボタンを押して編集操作をすると、その場ですぐに ファイルが更新されます。従来のロード・セーブという手順ではなく、ロード した後に、追加、削除、更新などをすると、それは即ファイルにも反映されて ています。これは、手軽な反面やり直しがきかないという欠点も持っている ので、注意してください。 ということで、このツールに「セーブ」はありません。HSファイルをロード するには、メインウインドゥの「開くFile」ボタンを押してください。 ここで、HSデータを選択するとファイルがロードされます。 現在ロードされているファイルに含まれているヘルプデータは、「index一覧」 のウインドゥにリストボックスとして表示されています。 このリストを選び、「選択」ボタンを押すとメインウインドゥにその内容が 表示されます。また、リストを選び「削除」ボタンを押すと、その項目が すぐに削除されます。
メインウインドゥの下には、編集のためのボタンがあります。 「追加」は、現在メインウインドゥで編集している内容を新しい項目として 追加します。「修正」は、「index一覧」から呼び出した内容を更新する場合 に押してください。 「クリア」は、メインウインドゥの内容をすべてクリアします。 「CLIP」は、クリップボードにコピーされているテキストの内容を、htmlと して解釈して、HSPヘルプに変換してメインウインドゥに貼り付けます。
「新規ファイル」は、まったく新しくHSデータを作成する場合に使います。 また、HS_WRITEの起動時はデフォルトの設定としてdefault.hsのデータが ロードされます。
「詳細情報」ウインドゥには、HSデータに1つだけ保存されている詳細データ の編集をすることができます。内容を更新する場合は、「更新」ボタンを 押して下さい。
・著作権および連絡先
HSP HELP Toolsおよびそれに付属するマニュアルの著作権はonion software にあります。 onion softwareは本プログラムによって生じた、いかなる 損害についても 保証いたしません。自己の責任の範囲で使用してください。
HELPMAN.EXEシステムで使用できるHS形式のデータは、自由に公開、配布して 頂いて構いません。また、HSP本体に付属する標準のHS形式データについては、 自由に改変、流用、展示、配布、販売をしてかまいません。添付されている ソーススクリプトHELPMAN.AS及び、mod_hs.asの著作権はONION softwareでは 主張しません。HELPMAN.ASを改造、改変したもの、HS形式に対応するソフトを 独自に作成したものを公開、配布、販売してもかまいません。 いずれの場合もライセンス料や事前の連絡は必要ありません。 ただし、HELPMAN.ASを改造・改変したものを公開する場合は、オリジナルの ものと区別がつく形で公開するようにしてください。
雑誌やCDなど他のメディアに掲載、 紹介される場合は、作者までご一報頂けると 嬉しいです。 このソフトに関するお問い合わせ、感想、ご意見などはこちらまで。
e-mail : onitama@onionsoft.net (internet)