lang/en_utf8/help/roles.html

   1 <h1>Roles</h1>
   2
   3 <p>
   4 A role is a collection of permissions defined for the whole site
   5 that you can assign to specific users in specific contexts.
   6 </p>
   7
   8 <p>
   9 For example, you may have a Role called "Teacher" that is set up to
  10 allow teachers to do certain things (and not others).   Once this role
  11 exists, you can assign it to someone in a course to make them a "Teacher"
  12 for that course.  You could also assign the role to a user in the
  13 course category to make them a "Teacher" for all the courses under that
  14 category, or assign the role to a user just in a single forum, giving
  15 that user those capabilities just in that forum.
  16 </p>
  17
  18 <p>
  19 A role must have a <strong>name</strong>.  If you need to name the role for multiple
  20 languages you can use multilang syntax if you wish, such as <pre>
  21   &lt;span lang="en">Teacher&lt;/span>
  22   &lt;span lang="es_es">Profesor&lt;/span>
  23   </pre>If you do this make sure the setting to "filter strings" is on for your installation.
  24 </p>
  25
  26 <p>
  27 The <strong>shortname</strong> is necessary for other plugins in Moodle that may need
  28 to refer to your Roles (eg when uploading users from a file or setting
  29 enrolments via an enrolment plugin).
  30 </p>
  31
  32 <p>
  33 The <strong>description</strong> is simply to describe the role in your own words, so
  34 that everyone has a common understanding about the role.
  35 </p>
  36
  37 <p>
  38 See also
  39 <a href="help.php?file=contexts.html">Contexts</a>,
  40 <a href="help.php?file=permissions.html">Permissions</a>,
  41 <a href="help.php?file=assignroles.html">Assign Roles</a> and
  42 <a href="help.php?file=overrides.html">Overrides</a>.
  43 </p>