のどか GuiEdit ヘルプ

Copyright © 2013 applet <applet@bp.iij4u.or.jp>

1. のどかGuiEdit とは
   汎用キーバインディング変更ソフト「のどか」の設定ファイルをGUI操作で編集できる機能を持ちます。
   32bitプログラムであり、Visual Studio 2010 C# で記述されています。Windows XP以降での環境をサポートします。
   もし実行ファイル単体で、「のどか」がインストールされたPCとは異なる環境で動作させる場合、Microsoft .Net Framework 4.0のランタイムのインストールが必要となることがあります。
   バージョン履歴も、ご覧ください。
   「注意」
   未実装、制限事項や、バグも存在するので、大事な設定ファイルは必ず、別途別の場所へ保存されることをお勧めします。失われた設定ファイルを回復する手段は存在しません。
   未保証であり、現在の動作は、あるがままとなります。7. 仕様、制限事項、バグの項もご覧ください。ご了承ご理解いただけない場合には、ただちにご利用をおやめください。

2. 用語の説明
   キャプション：　「のどか」設定ファイルの1行ごとに説明文を付けることができます。その説明文のことを、本プログラムでは、キャプションと呼びます。
   なお設定ファイル上では、文末に位置するコメントとして記述されます。またGUI画面上では、説明(キャプション)と表記しています。

3. 特徴
   ・「のどか」の設定ファイルと互換性を保ちながらも、GUI編集できることを目標としています。
   ・各行にキャプションを付けることで、その行に指定されたキーバインド変更内容の理解に役立ちます。
   ・各行を個別に、あるいは複数行まとめてコメント化、あるいはコメントを取りやめることで、機能のオンオフが簡単に指定可能です。
   ・コマンドウィザード機能を用いて、キー名称をリストボックスから簡単に選択可能です。

4. 起動終了方法
   通常、「のどか」の設定ダイアログの「GUI編集」ボタンから起動できます。その場合、設定ファイルは自動的に読み込まれ、終了時には、設定ファイルは自動保存されるモードとなります。
   のどかGuiEdit(GuiEdit.exe)単体でも起動終了可能ですが、その場合には、自動保存モードにはなりません。なおショートカットは「のどか」インストール時に作成されないので、個別に起動させることが多いようならば、別途ショートカットをご作成ください。

5. 編集画面メイン
   (1) 起動画面
   起動した場合、下記のようなメインダイアログが表示されます。
   これでは、どこから入力してよいのか不明だと思います。そこで左上のファイルメニューから「開く」を選択し、設定ファイルを選んで開いた場合を次に示します。
   (2) 設定ファイルを開いた場合
   こちらが設定ファイルを開いた時の画面です。ウィンドウを左右上下に広げました。
   少しニュアンスが伝わると思います。従来の設定ファイルと似たような感じで表示されます。次に、このメイン画面の各部位の説明を行います。
   (3) メイン画面の各部位の説明
   下記の図に、各部位の説明を示します。
   - 行全体について -
   ・左端の行番号が書かれた部位をクリックすると、行全体を選択したことになります。
   ・行全体を選択しているときに、行単位のコピー、カット、ペースト、挿入、削除ボタンは機能します。
   ・複数行を選択するには、シフトキーを押しながらか、コントロールキーを押しながらで、複数行選択が可能です。
   - 行単位のでの機能のオンオフやキャプションについて -
   ・各行は、行ごとのチェックボックスを☑すれば、コメント行となり、機能のオフとなります。オンにするには、チェックを外してください。
   ・複数行選択されているときには、一番上の「コメント」と書かれているところをクリックすれば、選択行全体のコメント化(無効化)、あるいは有効化が切り替わります。
   ・説明(キャプション)には、行がコメント化(無効化)、あるいは有効化に関係なく、コメントとして入力できます。
   - コマンド入力 -
   ・コマンド入力領域の左辺と右辺には、のどかの設定ファイルでのコマンドにおける「=」か「:」で区切られた左辺と右辺を入力可能です。
   左辺、右辺に区切られないコマンド記述の場合は、左辺に入れてください。
   右辺の文末に、「\」を入れると、次の行にネストする継続行となります。その場合、説明(キャプション)を入れることはできません。(入力できますが、継続行扱いになりません。)
   - その他 -
   ・下記図では説明していませんが、ボタンのうち、左側からの3個は、新規、ファイルを開く、上書き保存となります。また、右側からの3個のAのボタンは、フォントサイズを変更し、左から小さくする、標準に戻す。大きくする。です。
   続いて、コマンドウィザード(挿入ウィザード、再ウィザード)について説明を行います。

6. コマンドウィザード
   下記が、挿入ウィザードボタンあるいは、再ウィザードボタンを押したときに開くウィンドウです。
   コマンドウィザードとは、「のどか」の構文を構成する記述を、マウスで選択しながら入力可能となる機能です。
   挿入ウィザードの場合には、コマンド指定は「key」になります。
   再ウィザードの場合は、認識できサポートしているコマンドならば、コマンド指定はそれに合わせますが、認識できない場合、あるいは非サポートの場合は、「other」になります。
   この画面では、コマンドの選択、説明(キャプション)の入力が可能です。
   説明(キャプション)は、コマンド指定すると、すでに入力されたものがデフォルトの文言に置き換わるのでご注意ください。
   以降の説明では、「key」がコマンドとして指定されたとして、説明を進めます。他の現在サポートしているコマンド(keymap, mod, include, other)については説明を省きますが、概ね下記説明と同様の動きとなります。
   続いて、「次」ボタンを押すと、次のタブに移動します。
   下記が、次のタブに移った状態です。
   変更前のキーバインドを入力することになります。
   まず、画面の下部で、他のモディファイヤを無視する。および、キーボードの種別101/104か、106/109かを選択してください。日本語キーボードならば106/109を選択することになります。
   他のモディファイヤを無視するに☑すると、key指定する行に、「*」が挿入されます。
   画面の下側で、モディファイヤ、キーの種類、キーを順にマウスでクリックしていけば、画面の上側下のエディットボックスにコマンド記述が自動生成されます。
   なお、マウスで選択できない記述(モディファイヤなら「~」や「U-」「D-」など)の場合には、直接キー入力することも可能です。その場合には、画面下部の選択は実施しないでください。(上書きされてしまいます。)
   続いて、「次」ボタンを押して、次のタブに移ります。
   下記が、さらに次のタブに移った状態です。
   変更後のキーバインドを入力することになります。
   まず、画面の下部の追加モードのチェックボックスをチェックするかどうかご検討ください。
   ☑すると、下部で選択したキーを連続して、追加挿入することが可能です。下記では、「N」「O」「D」「O」「K」「A」を順番に入力した例となります。
   もし、ここで、下部のリストボックスをマウスでクリックせずに、直接、上側のエデットボックスに入力する場合、文頭の「=」を忘れずに入力してください。
   key文など、「=」が必要な構文の場合、入力し忘れると、「のどか」にロードした際、エラーとなります。
   すべて入力が終わったら、「OK」ボタンを押してください。入力内容を破棄する場合には、「Cancel」ボタンをいつでも押すことも可能です。
   下記が、コマンドウィザードを用いて入力したあとで、メイン画面に戻った時の例となります。

7. 仕様、制限事項、バグ
   下記に示す仕様、制限事項、バグが存在します。将来的にはすべての制限事項の撤廃が目標となりますが、実現困難な場合には仕様として確定することがあります。
   なお現在、制限事項だが仕様という形になっているものが、将来改善する可能性もあります。また、使い勝手の向上やご要望、バグ報告などに対し、緊急性や工数に応じて優先順位づけすることがあります。
   (1) 仕様
   1) キャプションを入れた行は 文末の\で、次の行にネストすることが出来ません。(キャプションを文末のコメント文で実現しているため)
   2) ファイル保存時に必ずバックアップファイルを作成します。
   3) キャプション、コメント文のいずれも、設定ファイル上は、コメント文であり、また機能のオンオフは行頭のコメント行で実現しています。
   (2) 制限事項あるいはバグ
   1) 文字コードはShift-JISのみサポートしています。一部の設定ファイルはUnicodeを用いていますが、正常に読み込めません。また保存時に異なる文字コードにすることもできません。
   設定ファイルを壊す危険性があるため、必ずバックアップを作成しますが、壊れることもあることにご留意し、バックアップを別途別の場所に保存されることを、お勧めします。
   2) 編集入力により設定ファイルが変更されているときには、自動保存あるいは、未保存時に確認ダイアログを出すようになっていますが、その認識に失敗し、保存済と判断することがあります。
   3) 設定ファイルが文法上おかしかったり、最小限必要なinclude文やkeymap文が存在しなくても、のどかGuiEdit側では一切チェックしていないので、「のどか」本体で読み込ませたときにエラーとなることがあります。
   4) 設定ファイルをdrap&dropでロードすることはできません。
   5) ファイルオープン、クローズ時に、以前のフォルダを覚えないことがあります。
   6) 設定ファイルがシンボリックリンクの場合は読み込めません。
   7) Undoや印刷機能、検索、置換、ジャンプ機能、設定などはまだ実装されていません。
   8) 表示フォントを変更できません。
   9) Windows 8ストアアプリではありません。
   10) 複数起動可能ですが、自動保存や、104/109キーボードの別は双方に反映され、個別には機能しません。
   11) 右クリックによるショートカットがありません。
   12) 直接入力した場合、コマンドの左辺と右辺の間に=(等号)が必要な場合にでも自動的に入りません。
   13) コピー、カット、ペースト、行挿入、行削除ボタンは、行選択の時のみ有効です。
   14) コマンド挿入ウィザードでは、サポートしていないコマンドが多くあり、リストに出てくるものの中でサポートしているものは、keymap, key, mod, includeのみです。
   またkeyseq定義されたものや、ファンクションなどはサポートできていません。
   15) キー名称などは、109.nodokaなどを読み込んで定義されているものを使用していません。
   16) コマンド挿入ウィザードでは、タブ間の移動の際、以前の設定がクリアされず、入力しようとしているコマンドとは異なる場合があります。
   17) また、タブが不要な場合でも削除されずに、無用なタブやコントロール部品が残ったままとなります。
   18) モディファイヤーのウィザード入力において、選択できないモディファイヤーが存在します。~や、U-、D-などは手動入力する必要があります。
   19) Windowクラス名、タイトル名、バイナリ名を取得する機能はありません。
   20) 終了時のウィンドウの大きさ、位置は保存されません。
   21) 英語版は存在しません。
   上記以外にも未確認の不具合などが存在することがあります。

8. 著作権、ライセンス、使用許諾条件
   著作権は、合同会社アプレット applet@bp.iij4u.or.jp にあります。
   また、ライセンスや使用許諾条件は、お使いの「のどか」本体と同じとなります。

9. バージョン履歴
   2013-04-07 1.0.0 1stリリース。