User documentation [#82517]

How does one use the different commands (/kick /ban /block /invite). I figured out kick easily enough. If I use /block and /ban, how do I unblock and ban? And what's the difference between the two? Also, when I use /invite (username), it just displays the text in the chatroom. How does it actually invite the user? Are there any other commands?

It'd be great to have this built into the module or documentation per other requests, but just a general description here would be sufficient for now to get me to be able to use the commands.

- Jason

Comment	File	Size	Author
#5	documentation.zip	1.64 KB	darren oh

Comments

Comment #1

moshe weitzman commented 6 September 2006 at 17:51

Perhaps you could document what you have learned so far, and suggest what else needs documenting. That might incent others to fill in the blanks. To start, just posting some text. If you can do light coding, expand chatroom_help() so it produces more help on the admin/help page.

Comment #2

whatistocome commented 7 September 2006 at 00:53

Give me feedback and details for sections marked with brackets [ ] and i'll update appropriately. i'll also add a handbook module page and try my hand at expanding chatroom_help(). Are there any other commands I'm missing?

--------

The chatroom module allows users to talk with each other in real time. Users enter chat rooms which can have multiple chats. Permissions can be set to restrict who can access, edit and create chats and chat rooms.

The following commands can be used by administrators while they are in a chat:

/kick (username) - The user will be kicked from the chat and the user will see a redirected to a message page (message is configurable). The other users in the chat will just see that the user has left the chat. [Can the kicked enter the chat again?]

/ban (username) - [Needs documented. Will the user be banned from just the specific chat or all chat rooms? How are they unbanned?]

The following commands can be used by all users while they are in a chat:

/invite (username) – [Needs documented. This command doesn’t seem to work? I type in /invite (username) and it just displays those words on the screen and doesn’t seem to invite the test user.]

/block (username) – [Needs documented. How is this different than ban/kick? How does one unblock someone? I’m assuming this is a command anyone can use or is it just admins?]

You can:

View chatrooms (link to /chatrooms)
Administer chatrooms (link to /admin/chatroom)

Comment #3

whatistocome commented 8 September 2006 at 16:27

Can someone tell me how to use the /invite option? i don't even know if it's functional; i type /invite (username) and it just echo's that to the screen - never inviting my test user account that i can see (that's logged into the site on a test box sitting next to me).

This is really affecting my site right now - i've installed and made chat live, but no one has any way of inviting people :-< so it's kind of useless right now.

Comment #4

Anonymous (not verified) commented 8 September 2006 at 23:29

sorry for the delayed response, and thanks for starting on this.

i'll be working on the chatroom for the next two days solid, during which time i'll use what you've started to document the chatroom features properley.

/kick (username) - The user will be kicked from the chat and the user will see a redirected to a message page (message is configurable). The other users in the chat will just see that the user has left the chat. [Can the kicked enter the chat again?]

the kicked user can enter the chatroom again. this is designed as a short term measure aimed at anonymous users. its not really possible to permanently ban anonymous users, as it is trivial to change the session id and come back as a "new user". at the point where it really becomes a problem, then only allowing logged in users access to the chatroom in question is the next step.

/ban (username) - [Needs documented. Will the user be banned from just the specific chat or all chat rooms? How are they unbanned?]

you can ban from both chat and chatroom. currently, (in unreleased code), unbanning is done via the edit interface for the chat or chatroom node in question.

/invite (username) – [Needs documented. This command doesn’t seem to work? I type in /invite (username) and it just displays those words on the screen and doesn’t seem to invite the test user.]

not completed yet, as you've noted.

again, sorry for the delay, i've been working on the project and project_issue modules, but i'll be turning my attention back to the chatroom module over the next few weeks.