Difference between revisions of "Chat settings"

Jump to: navigation, search
m (See also: removing links)
 
(84 intermediate revisions by 29 users not shown)
Line 1: Line 1:
'''Note for Contributors'''
+
{{Chat}}
This page should explain what can be seen on the <u>moodlesite.com/course/mod.php</u> page
 
when adding a chat
 
  
  
==Name of this chat room==
+
==Adding a Chat to your course==
  
A short name of the chat, which will be displayed on the course homepage.
+
*With the editing turned on, in the section you wish to add your chat, click the "Add an activity or resource" link (or, if not present, the "Add an activity" drop down menu ) and choose ''Chat'' All settings may expanded by clicking the "Expand all" link top right.
  
  
==Introduction text==
+
===General===
 +
{|
 +
|[[File:chatgeneral26.png|General settings expanded by default]]
 +
|}
  
Type the description of the chat here. Include precise instructions for students regarding the subject of the chat.  
+
===Name of this chat room===
 +
*Whatever you type here will form the link learners click on to enter the chat so it is helpful to give it a name that suggests its purpose - for example "Student council discussion" or "Field trip planning meeting".
  
 +
===Description===
 +
Type the description of the chat here. Include precise instructions for students regarding the subject of the chat. Click the icon on the left to expand the toolbar, and drag the bottom right of the text box out to expand it.
  
==Next chat time==
+
===Display description on course page===
 +
If this box is ticked, the description will appear on the course page just below the name of the Chat.
  
The day and hour of the next chat session.  
+
==Chat sessions==
 +
(These settings are collapsed by default.)
  
 +
{|
 +
|[[File:chatsessions25.png|thumb|450px|Chat sessions settings expanded.]]
 +
|}
 +
===Next chat time===
  
==Repeat sessions==
+
*The day and hour of the next chat session. This will appear in the calendar so students know the schedule but it doesn't stop them accessing the chatroom at any other time.
 +
*If you don't want them in the chatroom at other times, then hide it (with the eye icon) or use [[Conditional activities]] to restrict access.
 +
*If you don't wish to schedule chat times then ignore this and choose from the next settings.
  
You can choose any out of four options allowing to schedule the future chat sessions:
+
'''Note:'''For courses involving users across different time zones, it is useful to know that the time you set here will be adjusted to match the time zone of the user viewing it.
  
# Don't publish any chat times
+
===Repeat/publish sessions===
# No repeats - publish the specified time only
 
# At the same time every day
 
# At the same time every week
 
  
 +
*There are  four options for scheduling  future chat sessions:
  
==Save past sessions==
+
# '''Don't publish any chat times'''- there are no set times and students are welcome to chat at any time.
 +
# '''No repeats - publish the specified time only'''- only  the Next chat  time will be published.  This could be used to schedule special events or meetings or simply to help learners identify a common time in which they can expect to find other learners in the chat room.
 +
# '''At the same time every day'''- Daily chats are useful for scheduling daily office hours or work sessions with learners.
 +
# '''At the same time every week'''--This setting will  schedule a chat for the same day and time every week, which could be useful for instance for meeting and reviewing key ideas and questions related to the week’s content/assessment.
  
You can determine the number of days (or rather, choose out of several options
+
===Save past chat sessions===
  
 +
*Choose from the dropdown how many days to save - or save everything by selecting ''Never delete messages''
 +
*If you have any concerns about discussions that might take place in your chat room, you may want to keep transcripts to check the suitablility of what is discussed. If your learners are using the chatroom to collaborate on a group project you won't want to delete the messages until the project is complete.
  
==Everyone can view past sessions==
+
===Everyone can view past sessions===
  
You can decide here whether or not allow everyone to view past chat sessions.  
+
*Decide here whether or not allow everyone to view past chat sessions. (Teachers can always view past sessions)
  
 +
==Common module settings==
 +
(These settings are collapsed by default.)
  
==Group mode==
+
See [[Common module settings]]
  
This sets the group mode of the choice activity to one of the following three:
+
==Restrict access/Activity completion==
 +
(These settings are collapsed by default)
  
# No groups - there are no sub groups, everyone is part of one big community
+
These settings are visible if [[Conditional activities]] and [[Activity completion]] have been enabled in the site and the course.
# Separate groups - each group can only see their own group, others are invisible
 
# Visible groups - each group works in their own group, but can also see other groups
 
  
The group mode can be defined at two levels:
+
==Locally assigned roles==
  
 +
*In ''Administration > Chat administration > Locally assigned roles'' selected users can be given additional roles in the activity, such as the capability to delete chat logs.
  
* Course level
+
*Role permissions for the activity can be changed in ''Administration > Chat administration > Permissions''.
  
The group mode defined at the course level is the default mode for all activities defined within that course
+
==Site administration settings==
  
 +
The chat module has additional settings which may be changed by an administrator in ''Administration > Site administration > Plugins > Activity modules > Chat''. They depend on the chat method which has been selected:
  
* Activity level
+
[[File:Chatmethod.png]]
  
Each activity that supports groups can also define its own grouping mode. If the course is set to "force group mode" then the setting for each activity is ignored.  
+
===Ajax===
 +
*This is the default method. It works everywhere but if many people are chatting it can put a large load on the server. Its particular settings are: 
 +
**'''Refresh user list'''  - choose the number of seconds after which the user list is refreshed
 +
**'''Disconnect timeout''' - choose the number of seconds after which we detect a user has disconnected.
  
 +
===Normal method===
 +
*The particular settings for this method are:
 +
**'''Refresh room''' - choose the number of seconds after which the room is refreshed
 +
**'''Update method''' - choose how to update the chatroom - "Keep alive" or "Stream" strategy. Stream works better but your sever might not support it.
  
==Visible to students==
+
===Chat server daemon===
 +
*A daemon is a program that runs all the time in the background. In this case it's a PHP script, listening to a particular port on your server, accepting and giving out chat information.If you intend to use the chat activity a lot, then you should consider using a chat server daemon to reduce server load.Its particular settings are:
 +
**Server name
 +
**Server IP address
 +
**Server port
 +
**Max users
  
You can hide the activity from students by selecting "Hide" here. It is useful if you wouldn't like to make the activity available immediately.
+
Then you need to start the chat daemon script from the command line:
 +
 
 +
cd moodle/mod/chat
 +
php chatd.php --start &
 +
 
 +
How to stop the chat daemon script:
 +
 
 +
Moodle staff, please give details!
 +
 
 +
One option is to restart the server via the command line:
 +
 
 +
sudo reboot
 +
 
 +
==Chat capabilities==
 +
 
 +
*[[Capabilities/mod/chat:chat|Access a chat room]]
 +
*[[Capabilities/mod/chat:deletelog|Delete chat logs]]
 +
*[[Capabilities/mod/chat:exportparticipatedsession|Export chat session which you took part in]]
 +
*[[Capabilities/mod/chat:exportsession|Export any chat session]]
 +
*[[Capabilities/mod/chat:readlog|Read chat logs]]
 +
*[[Capabilities/mod/chat:addinstance|Add a new chat]]
 +
 
 +
[[de:Chat konfigurieren]]
 +
[[fr:Ajouter/modifier un chat]]
 +
[[es:Configuraciones de chat]]

Latest revision as of 07:12, 26 October 2017


Adding a Chat to your course

  • With the editing turned on, in the section you wish to add your chat, click the "Add an activity or resource" link (or, if not present, the "Add an activity" drop down menu ) and choose Chat All settings may expanded by clicking the "Expand all" link top right.


General

General settings expanded by default

Name of this chat room

  • Whatever you type here will form the link learners click on to enter the chat so it is helpful to give it a name that suggests its purpose - for example "Student council discussion" or "Field trip planning meeting".

Description

Type the description of the chat here. Include precise instructions for students regarding the subject of the chat. Click the icon on the left to expand the toolbar, and drag the bottom right of the text box out to expand it.

Display description on course page

If this box is ticked, the description will appear on the course page just below the name of the Chat.

Chat sessions

(These settings are collapsed by default.)

Chat sessions settings expanded.

Next chat time

  • The day and hour of the next chat session. This will appear in the calendar so students know the schedule but it doesn't stop them accessing the chatroom at any other time.
  • If you don't want them in the chatroom at other times, then hide it (with the eye icon) or use Conditional activities to restrict access.
  • If you don't wish to schedule chat times then ignore this and choose from the next settings.

Note:For courses involving users across different time zones, it is useful to know that the time you set here will be adjusted to match the time zone of the user viewing it.

Repeat/publish sessions

  • There are four options for scheduling future chat sessions:
  1. Don't publish any chat times- there are no set times and students are welcome to chat at any time.
  2. No repeats - publish the specified time only- only the Next chat time will be published. This could be used to schedule special events or meetings or simply to help learners identify a common time in which they can expect to find other learners in the chat room.
  3. At the same time every day- Daily chats are useful for scheduling daily office hours or work sessions with learners.
  4. At the same time every week--This setting will schedule a chat for the same day and time every week, which could be useful for instance for meeting and reviewing key ideas and questions related to the week’s content/assessment.

Save past chat sessions

  • Choose from the dropdown how many days to save - or save everything by selecting Never delete messages
  • If you have any concerns about discussions that might take place in your chat room, you may want to keep transcripts to check the suitablility of what is discussed. If your learners are using the chatroom to collaborate on a group project you won't want to delete the messages until the project is complete.

Everyone can view past sessions

  • Decide here whether or not allow everyone to view past chat sessions. (Teachers can always view past sessions)

Common module settings

(These settings are collapsed by default.)

See Common module settings

Restrict access/Activity completion

(These settings are collapsed by default)

These settings are visible if Conditional activities and Activity completion have been enabled in the site and the course.

Locally assigned roles

  • In Administration > Chat administration > Locally assigned roles selected users can be given additional roles in the activity, such as the capability to delete chat logs.
  • Role permissions for the activity can be changed in Administration > Chat administration > Permissions.

Site administration settings

The chat module has additional settings which may be changed by an administrator in Administration > Site administration > Plugins > Activity modules > Chat. They depend on the chat method which has been selected:

Chatmethod.png

Ajax

  • This is the default method. It works everywhere but if many people are chatting it can put a large load on the server. Its particular settings are:
    • Refresh user list - choose the number of seconds after which the user list is refreshed
    • Disconnect timeout - choose the number of seconds after which we detect a user has disconnected.

Normal method

  • The particular settings for this method are:
    • Refresh room - choose the number of seconds after which the room is refreshed
    • Update method - choose how to update the chatroom - "Keep alive" or "Stream" strategy. Stream works better but your sever might not support it.

Chat server daemon

  • A daemon is a program that runs all the time in the background. In this case it's a PHP script, listening to a particular port on your server, accepting and giving out chat information.If you intend to use the chat activity a lot, then you should consider using a chat server daemon to reduce server load.Its particular settings are:
    • Server name
    • Server IP address
    • Server port
    • Max users

Then you need to start the chat daemon script from the command line:

cd moodle/mod/chat
php chatd.php --start &

How to stop the chat daemon script:

Moodle staff, please give details!

One option is to restart the server via the command line:

sudo reboot

Chat capabilities