Merge lp:~cjohnston/ubuntu-classroom/help-update into lp:~ubuntu-classroom/ubuntu-classroom/classbot

[Chris Johnston]

[Chris Johnston (cjohnston)]

Updated help section

[Nathan Handler (nhandler)]

Please use $chan and $qchan instead of #ubuntu-classroom and #ubuntu-classroom-chat. As this help is only able to be seen by people with access to irssi, it would probably make sense to include the admin-only commands in there as well.

review: Needs Fixing

[lp:~cjohnston/ubuntu-classroom/help-update]

17. By Chris Johnston on 2010-02-21

Updated to include admin commands and $chan/$qchan

[Nathan Handler (nhandler)]

Looks good.

review: Approve

=== modified file 'classbot.pl'
--- classbot.pl	2010-02-20 22:10:26 +0000
+++ classbot.pl	2010-02-21 04:49:12 +0000
@@ -396,9 +396,17 @@
 	my($data, $server, $witem) = @_;
 
 	if($data=~m/^classbot$/i) {
-		Irssi::print("!question or !q: Review the next question in the queue.");
-		Irssi::print("!no [comment] or !n [comment]: Ignore the question being reviewed. If a comment is specified, it will be displayed in $qchan");
-		Irssi::print("!yes or !y: Approve the question being reviewed. It will be displayed in $chan");
+		Irssi::print("User Interaction:");
+		Irssi::print("	At the present time, the only possible user interaction is for a user to ask a question using the format QUESTION: in $qchan");
+		Irssi::print("Instructor & Session Helper Interaction:");
+		Irssi::print("	!question or !q: Review the next question in the queue.");
+		Irssi::print("	!no [comment] or !n [comment]: Ignore the question being reviewed. If a comment is specified, it will be displayed in $qchan");
+		Irssi::print("	!yes or !y: Approve the question being reviewed. It will be displayed in $chan");
+		Irssi::print("	!moderate or !m: Toggles the moderate mode (+/-m) in $chan. Default is moderated (+m) during a session");
+		Irssi::print("Admin Interaction:");
+		Irssi::print("	An admin has all the rights listed above.");
+		Irssi::print("	!voice or !v [nick]: This commands can be used with or without someones nick. If they are used with a nick, that user will be voiced, otherwise the admin running the command will be voiced.");
+		Irssi::print("	!devoice or !dv [nick]: This commands can be used with or without someones nick. If they are used with a nick, that user will be devoiced, otherwise the admin running the command will be devoiced.");
 		Irssi::print("For more information about ClassBot visit: https://wiki.ubuntu.com/Classroom/ClassBot");
 	}
 }