Renamed.
[riece] / doc / HACKING
index f64945b..882d835 100644 (file)
@@ -17,7 +17,7 @@ riece-debug to t before preparing a bug report.
 If the riece-debug variable is set to t, Riece begins to collect
 debugging information in *Debug* buffer.  Interactions with IRC
 servers are stored in " *IRC*<IRC-server-name>" buffers.  Note that
-these buffer names start with a whitespace character (" ").
+these buffers have names starting with a whitespace character (" ").
 
 ** Joining the development
 
@@ -26,10 +26,9 @@ To join the development, send us a patch or an add-on.
 ** CVS
 
 Development of Riece uses CVS.  Latest developing version is available
-at CVS.  Please note that the newest development version from CVS may
-NOT be reliable.  You can only use it at your own risk.  We may ignore
-bug reports for that version.  The instruction to access the CVS
-server is below.
+at CVS.  Please note that the version from CVS may NOT be reliable,
+and you can only use it at your own risk.  We may ignore bug reports
+for that version.  The instruction to access the CVS server is below.
 
 (1) logging in to anonymous CVS server
 
@@ -164,7 +163,7 @@ needed to distinguish process object of each connection by its name.
 
 It can be known by:
 
-(1) checking the value of riece-overrinding-server-name,
+(1) checking the value of riece-overriding-server-name,
 
 (2) checking the value of riece-server-name,
     (If the variable riece-server-name is local to the current buffer,
@@ -306,7 +305,7 @@ riece-connect-signal.
   the fourth argument of riece-connect-signal.
 
   If the third argument filter-function is specified, the
-  slot-function is called conditionaly.  The filter-function gets the
+  slot-function is called conditionally.  The filter-function gets the
   signal object and returns nil or t.  If the return value is nil, the
   slot-function is not called.
 
@@ -385,28 +384,26 @@ Below is a list of signal names reserved.
 Elisp modules that satisfy add-on spec should provide the following
 functions.
 
-- <module-name>-requires
-  Return a list of names of other add-ons this add-on depends. (optional)
+- <module-name>-requires (optional)
+  Return a list of names of other add-ons this add-on depends.
 
 - <module-name>-insinuate
   Called on initialization of this module.
 
+- <module-name>-enable (optional)
+  Called when this add-on is enabled.
+
+- <module-name>-disable (optional)
+  Called when this add-on is disabled.
+
 It is recommended to set short explanation of the add-on to
 <module-name>-description variable which is displayed on add-on
 listing shown up by C-c ^ (M-x riece-command-list-addons).
 
-Add-ons that support enabling/disabling set the current status to
-<module-name>-enabled variable.  If this variable is nil, the add-on
-is regarded as currently disabled.  In addition, the add-on must
-provide the following two functions.
-
-- <module-name>-enable
-  Called to enable this add-on.
-
-- <module-name>-disable
-  Called to disable this add-on.
+To see the add-on's enabled/disabled status, check riece-addon-enabled
+property set on <module-name> symbol.
 
-Riece does the following process when startup.
+Riece does the following procedure on add-ons when startup.
 
 (1) Load add-ons listed in the riece-addons variable.