X-Git-Url: https://cgit.sxemacs.org/?p=riece;a=blobdiff_plain;f=doc%2FHACKING.ja;h=4a492e86b2dfede6c74bed423be40ea5af19eb6f;hp=cff339b8ff621cef2953fa502e01537c6053ff86;hb=bc851618c53132fea5c1dda9968ae30cdad7beef;hpb=621b599b2dd65e8d1ac9c7053b10bdb20212a420 diff --git a/doc/HACKING.ja b/doc/HACKING.ja index cff339b..4a492e8 100644 --- a/doc/HACKING.ja +++ b/doc/HACKING.ja @@ -169,6 +169,7 @@ riece-identity オブジェクトは以下の 2 つの要素をもつベクターです。 - prefix チャンネル名やニックネームなど、IRC サーバに固有の名前 + - server IRC サーバの名前 @@ -215,7 +216,7 @@ riece-channel はチャンネルを表すオブジェクトで、以下の要素を持ちます。 発言権をもつユーザのニックネームのリスト - modes -チャンネルのモード + チャンネルのモード - banned MODE +b で指定されたパターンの一覧 @@ -275,7 +276,8 @@ riece-naming が提供する主な関数は以下の 3 つです。 シグナルを送信するには、riece-emit-signal を使います。 - riece-emit-signal signal-name &rest args -引数 signal-name で指示されるシグナルを、引数 args とともに送出します + 引数 signal-name で指示されるシグナルを、引数 args とともに送出しま + す シグナルに応答する処理は、riece-connect-signal を使って定義します。 @@ -356,25 +358,27 @@ riece-naming が提供する主な関数は以下の 3 つです。 アドオンの条件を満たすモジュールは以下の関数を提供します。 -- <モジュール名>-requires - 依存する他のアドオン(シンボルのリスト)を返します(オプション) +- <モジュール名>-requires (オプション) + 依存する他のアドオン(シンボルのリスト)を返します - <モジュール名>-insinuate 初期化処理を行います +- <モジュール名>-uninstall (オプション) + アドオンをアンインストールすると呼ばれます + +- <モジュール名>-enable (オプション) + アドオンの有効にすると呼ばれます + +- <モジュール名>-disable (オプション) + アドオンの無効にすると呼ばれます + また、アドオンの簡単な説明を、変数 <モジュール名>-description に設定す ると良いでしょう。この文字列は C-c ^ (M-x riece-command-list-addons) によるアドオンの一覧で表示されます。 -有効化・無効化に対応したアドオンは、変数 <モジュール名>-enabled に現在 -の状態を保持します。この変数の値が nil であれば無効、t であれば有効で -す。加えて、以下の関数を提供します。 - -- <モジュール名>-enable -アドオンを有効にします - -- <モジュール名>-disable -アドオンを無効にします +アドオンの有効・無効の状態は、<モジュール名> のシンボルに +付与される riece-addon-enabled プロパティで調べることができます。 Riece は起動時に以下の処理を行います。