mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-21 08:22:07 +02:00
Code Issues Projects Releases Wiki Activity

Merged documentation for Roles from stable MDL-6923

Browse Source
This commit is contained in:
moodler 2006-10-31 08:14:36 +00:00
parent 95f7634d4d
commit 8c900bc3b0
11 changed files with 222 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
admin/roles/assign.php
View File

@ -116,7 +116,6 @@
$adminroot = admin_get_root();
admin_externalpage_setup('assignroles', $adminroot);
admin_externalpage_print_header($adminroot);
print_heading($straction);
} else {
$currenttab = '';
$tabsmode = 'assign';
@ -179,6 +178,9 @@
}
}
print_heading_with_help(get_string('assignroles', 'role'), 'assignroles');
if ($roleid) { /// prints a form to swap roles
/// Get all existing participants in this context.
@ -243,14 +245,15 @@
$table->tablealign = 'center';
$table->cellpadding = 5;
$table->cellspacing = 0;
$table->width = '20%';
$table->head = array(get_string('roles', 'role'), get_string('users'));
$table->wrap = array('nowrap', 'nowrap');
$table->align = array('right', 'center');
$table->width = '60%';
$table->head = array(get_string('roles', 'role'), get_string('description'), get_string('users'));
$table->wrap = array('nowrap', '', 'nowrap');
$table->align = array('right', 'left', 'center');
foreach ($assignableroles as $roleid => $rolename) {
$countusers = count_role_users($roleid, $context);
$table->data[] = array('<a href="'.$baseurl.'&amp;roleid='.$roleid.'">'.$rolename.'</a>', $countusers);
$description = format_string(get_field('role', 'description', 'id', $roleid));
$table->data[] = array('<a href="'.$baseurl.'&amp;roleid='.$roleid.'">'.$rolename.'</a>',$description, $countusers);
}
print_table($table);

8
admin/roles/manage.php
View File

@ -281,13 +281,13 @@
switch ($action) {
case 'add':
print_heading_with_help(get_string('addrole', 'role'), 'role');
print_heading_with_help(get_string('addrole', 'role'), 'roles');
break;
case 'view':
print_heading_with_help(get_string('viewrole', 'role'), 'role');
print_heading_with_help(get_string('viewrole', 'role'), 'roles');
break;
case 'edit':
print_heading_with_help(get_string('editrole', 'role'), 'role');
print_heading_with_help(get_string('editrole', 'role'), 'roles');
break;
}
@ -318,6 +318,8 @@
} else {
print_heading_with_help(get_string('roles', 'role'), 'roles');
$table = new object;
$table->tablealign = 'center';

12
admin/roles/override.php
View File

@ -141,6 +141,7 @@
include_once('tabs.php');
}
print_heading_with_help(get_string('overrides', 'role'), 'overrides');
$overridableroles = get_overridable_roles($context);
@ -188,15 +189,16 @@
$table->tablealign = 'center';
$table->cellpadding = 5;
$table->cellspacing = 0;
$table->width = '20%';
$table->head = array(get_string('roles', 'role'), get_string('overrides', 'role'));
$table->wrap = array('nowrap', 'nowrap');
$table->align = array('right', 'center');
$table->width = '60%';
$table->head = array(get_string('roles', 'role'), get_string('description'), get_string('overrides', 'role'));
$table->wrap = array('nowrap', '', 'nowrap');
$table->align = array('right', 'left', 'center');
foreach ($overridableroles as $roleid => $rolename) {
$countusers = 0;
$overridecount = count_records_select('role_capabilities', "roleid = $roleid AND contextid = $context->id");
$table->data[] = array('<a href="'.$baseurl.'&amp;roleid='.$roleid.'">'.$rolename.'</a>', $overridecount);
$description = format_string(get_field('role', 'description', 'id', $roleid));
$table->data[] = array('<a href="'.$baseurl.'&amp;roleid='.$roleid.'">'.$rolename.'</a>', $description, $overridecount);
}
print_table($table);

34
lang/en_utf8/help/assignroles.html Normal file
View File

@ -0,0 +1,34 @@
<p align="center"><b>Assigning Roles</b></p>
<p>
By assigning a role to a user in a context, you
are granting them the permissions contained
in that role, for the current context and all
"lower" contexts.
</p>
<p>
Contexts:
<ol>
<li>Site/System</li>
<li>Course Categories</li>
<li>Courses</li>
<li>Blocks and Activities</li>
</ol>
</p>
<p>
So for example, if you grant a Student role to a
user in a Course, they will have that role for
the course, but also all Blocks and Activities inside
that course. Their actual permissions may depend on
other roles and overrides that have been defined.
</p>
<p>
See also
<a href="help.php?file=roles.html">Roles</a>,
<a href="help.php?file=contexts.html">Contexts</a>,
<a href="help.php?file=permissions.html">Permissions</a> and
<a href="help.php?file=overrides.html">Overrides</a>.
</p>

24
lang/en_utf8/help/contexts.html Normal file
View File

@ -0,0 +1,24 @@
<p align="center"><b>Contexts</b></p>
<p>Contexts are the "areas" in Moodle where roles
can be assigned to people</p>
<p>They are arranged in a hierarchical fashion, with permissions
inherited from "higher" to "lower" contexts.</p>
<ol>
<li>Site (System)</li>
<li>Course Categories</li>
<li>Course Sub-categories</li>
<li>Courses</li>
<li>Blocks and Activities</li>
</ol>
</p>
<p>
See also
<a href="help.php?file=roles.html">Roles</a>,
<a href="help.php?file=permissions.html">Permissions</a>,
<a href="help.php?file=assignroles.html">Assign Roles</a> and
<a href="help.php?file=overrides.html">Overrides</a>.
</p>

10
lang/en_utf8/help/index.html
View File

@ -9,6 +9,15 @@
<li><a href="help.php?file=search.html">How to search</a></li>
</ul>
<p>Roles</p>
<ul>
<li><a href="help.php?file=roles.html">Roles</a></li>
<li><a href="help.php?file=contexts.html">Contexts</a></li>
<li><a href="help.php?file=permissions.html">Permissions</a></li>
<li><a href="help.php?file=assignroles.html">Assign Roles</a></li>
<li><a href="help.php?file=overrides.html">Overrides</a></li>
</ul>
<p>Administration</p>
<ul>
<li><a href="help.php?file=advancedsettings.html">Advanced settings</a></li>
@ -19,7 +28,6 @@
<li><a href="help.php?file=langedit.html">Language editing</a></li>
<li><a href="help.php?file=uploadgroups.html">Upload groups</a></li>
<li><a href="help.php?file=uploadusers.html">Upload users</a></li>
</ul>
<p>Setting up courses</p>

40
lang/en_utf8/help/overrides.html Normal file
View File

@ -0,0 +1,40 @@
<p align="center"><b>Overrides</b></p>
<p>
Overrides are specific permissions designed to override a
role in a specific context, allowing you to "tweak" your
permissions as required.
</p>
<p>
For example, if users with the role Student in your course
can usually start new discussions in forums, but there is
one particular forum for which you want to restrict that
capability, then you can set an override that PREVENTS
the capability for Students to "Start new discussions".
</p>
<p>
Overrides can also be used to "open up" areas of your
site and courses to give users extra permissions where
it makes sense. For example, you may want to experiment
giving Students the ability to grade some assignments.
</p>
<p>
The interface is similar to the one for defining roles,
except sometimes only relevant capabilities are shown,
and you will also see some capabilities highlighted to
show you what the permission for that role would be
WITHOUT any override active (ie when your override is
set to INHERIT).
</p>
<p>
See also
<a href="help.php?file=roles.html">Roles</a>,
<a href="help.php?file=contexts.html">Contexts</a>,
<a href="help.php?file=assignroles.html">Assign Roles</a> and
<a href="help.php?file=permissions.html">Permissions</a>.
</p>

28
lang/en_utf8/help/permissions.html
View File

@ -12,7 +12,7 @@ For example, one capability is "Start new discussions" (in forums).
In each role, you can choose to set the permission for such a capability
to one of four values:
<dl>
<dt>Inherit</dt>
<dt>INHERIT</dt>
<dd>This is the default setting, generally. It's a neutral setting that
means "use whatever setting the user already had". If a role
gets assigned to someone (eg in a course) that has this permission for
@ -22,7 +22,7 @@ to one of four values:
level, then the user will have no permission for that capability.
</dd>
<dt>Allow</dt>
<dt>ALLOW</dt>
<dd>By choosing this you are granting permission for this capability
to people who are assigned this role. This permission applies
for the context that this role gets assigned plus all "lower"
@ -32,12 +32,12 @@ to one of four values:
override or a new assignment with a Prevent or Prohibit value
for this capability.</dd>
<dt>Prevent</dt>
<dt>PREVENT</dt>
<dd>By choosing this you are removing permission for this capability,
even if the users with this role were allowed that permission in
a higher context.</dd>
<dt>Prohibit</dt>
<dt>PROHIBIT</dt>
<dd>This is rarely needed, but occasionally you might want to completely
deny permissions to a role in a way that can NOT be overridden at
any lower context. A good example of when you might need this is
@ -52,13 +52,29 @@ to one of four values:
<p align="center"><b>Conflict resolution of permissions</b></p>
<p> Permissions at a "lower" context will generally override
anything at a higher "context" (this applies to overrides
and assigned roles). The exception is PROHIBIT which can not
be overridden at lower levels.
</p>
<p> If two roles are assigned to a person in the same context, one with
Allow and one with Prevent, which one wins? In this case, Moodle will
ALLOW and one with PREVENT, which one wins? In this case, Moodle will
look up the context tree for a "decider". </p>
<p> For example, a student has two roles in a course, one that allows
them to start new discussions, one that prevents them. In this case,
we check the categories and the site contexts, looking for another
defined permission to help us decide. If we don't find one, then
permission is prevented by default (the two settings cancelled each other out).
permission is PREVENT by default (because the two settings cancelled
each other out, and thus you have no permission).
</p>
<p>
See also
<a href="help.php?file=roles.html">Roles</a>,
<a href="help.php?file=contexts.html">Contexts</a>,
<a href="help.php?file=assignroles.html">Assign Roles</a> and
<a href="help.php?file=overrides.html">Overrides</a>.
</p>

43
lang/en_utf8/help/roles.html Normal file
View File

@ -0,0 +1,43 @@
<p align="center"><b>Roles</b></p>
<p>
A role is a collection of permissions defined for the whole site
that you can assign to specific users in specific contexts.
</p>
<p>
For example, you may have a Role called "Teacher" that is set up to
allow teachers to do certain things (and not others). Once this role
exists, you can assign it to someone in a course to make them a "Teacher"
for that course. You could also assign the role to a user in the
course category to make them a "Teacher" for all the courses under that
category, or assign the role to a user just in a single forum, giving
that user those capabilities just in that forum.
<p>
<p>
A role must have a <strong>name</strong>. If you need to name the role for multiple
languages you can use multilang syntax if you wish, such as <pre>
&lt;span lang="en">Teacher&lt;/span>
&lt;span lang="es_es">Profesor&lt;/span>
</pre>If you do this make sure the setting to "filter strings" is on for your installation.
</p>
<p>
The <strong>shortname</strong> is necessary for other plugins in Moodle that may need
to refer to your Roles (eg when uploading users from a file or setting
enrolments via an enrolment plugin).
<p>
<p>
The <strong>description</strong> is simply to describe the role in your own words, so
that everyone has a common understanding about the role.
<p>
<p>
See also
<a href="help.php?file=contexts.html">Contexts</a>,
<a href="help.php?file=permissions.html">Permissions</a>,
<a href="help.php?file=assignroles.html">Assign Roles</a> and
<a href="help.php?file=overrides.html">Overrides</a>.
</p>

10
theme/standard/styles_fonts.css
View File

@ -229,13 +229,19 @@ body#admin-index .copyright {
#admin-roles-manage .rolecap .cap-desc .cap-name,
#admin-roles-override .rolecap .cap-desc .cap-name {
font-size: 75%;
font-size: 0.75em;
}
#adminsettings .form-shortname {
font-size: 75%;
font-size: 0.75em;
}
#admin-roles-override .cell.c1,
#admin-roles-assign .cell.c1 {
font-size: 0.7em;
}
/***
*** Blocks
***/

36
theme/standard/styles_layout.css
View File

@ -69,6 +69,11 @@ h6.main {
display:block;
}
.clearfix {
min-width: 0;
overflow: hidden;
}
.clearfix:after {
/* content: "<!-- -->"; */
content: ".";
@ -399,16 +404,12 @@ form.mform div.error,form.mform fieldset.error {
}
.navbar {
width:100%;
width:auto;
padding:3px 0.5em;
border-width:1px;
border-style:solid;
}
div.navbar {
width: auto;
}
table.navbar {
width: 100%;
}
@ -551,7 +552,12 @@ body#admin-roles-manage table.generalbox {
#admin-roles-manage .rolecap .cap-desc .cap-name,
#admin-roles-override .rolecap .cap-desc .cap-name {
display: block;
display: block;
}
#admin-roles-override .cell.c1,
#admin-roles-assign .cell.c1 {
padding-top: 0.75em;
}
#adminsettings fieldset {
@ -664,9 +670,9 @@ a.skip-block, .skip-block {
ul.list, ul.list li, ol.list, ol.list li {
list-style-type:none;
padding:0%;
margin:0%;
text-indent:0%;
padding:0;
margin:0;
text-indent:0;
}
.sideblock .content h3,
@ -675,8 +681,8 @@ ul.list, ul.list li, ol.list, ol.list li {
}
/*.sideblock .content h3, ??*/
.sideblock .content h2 {
margin:0%;
padding:0%;
margin:1.5em 0 0;
padding:0;
}
.sideblock {
@ -686,7 +692,7 @@ ul.list, ul.list li, ol.list, ol.list li {
.sideblock .header, .sideblock h2.header {
text-align: left;
margin:0%;
margin:0;
padding:4px;
padding-top:0;
border-width: 1px;
@ -694,8 +700,8 @@ ul.list, ul.list li, ol.list, ol.list li {
border-bottom: none;
}
.sideblock h2 {
margin:0%;
padding:0%;
margin:0;
padding:0;
}
.sideblock .header .hide-show {
@ -1189,7 +1195,7 @@ body#course-view .unread {
margin-left: 3em;
}
body#course-view.editing .sideblock .header {
body#course-view.drag .sideblock .header {
cursor: move;
}