| 1 |
efrain |
1 |
moodle-block_people
|
|
|
2 |
===================
|
|
|
3 |
|
|
|
4 |
[](https://github.com/moodle-an-hochschulen/moodle-block_people/actions?query=workflow%3A%22Moodle+Plugin+CI%22+branch%3Amaster)
|
|
|
5 |
|
|
|
6 |
Moodle block which displays all teachers of a course with contact quicklinks, as well as a quicklink to the participants list
|
|
|
7 |
|
|
|
8 |
|
|
|
9 |
Requirements
|
|
|
10 |
------------
|
|
|
11 |
|
|
|
12 |
This plugin requires Moodle 4.3+
|
|
|
13 |
|
|
|
14 |
|
|
|
15 |
Motivation for this plugin
|
|
|
16 |
--------------------------
|
|
|
17 |
|
|
|
18 |
The block_people plugin displays a list of the course's teachers grouped by roles. The block shows the teacher's avatar, a quicklink to his/her profile and a quicklink to send him/her a message with the moodle message system. Furthermore, there is a quicklink to the participants list of the course.
|
|
|
19 |
|
|
|
20 |
|
|
|
21 |
Installation
|
|
|
22 |
------------
|
|
|
23 |
|
|
|
24 |
Install the plugin like any other plugin to folder
|
|
|
25 |
/blocks/people
|
|
|
26 |
|
|
|
27 |
See http://docs.moodle.org/en/Installing_plugins for details on installing Moodle plugins
|
|
|
28 |
|
|
|
29 |
|
|
|
30 |
Usage & Settings
|
|
|
31 |
----------------
|
|
|
32 |
|
|
|
33 |
After installing the plugin, it can be directly used by users and can be added to course overview pages.
|
|
|
34 |
|
|
|
35 |
To configure the plugin and its behaviour, please visit:
|
|
|
36 |
Site administration -> Plugins -> Blocks -> People.
|
|
|
37 |
|
|
|
38 |
There, you find three sections:
|
|
|
39 |
|
|
|
40 |
### 1. Roles
|
|
|
41 |
|
|
|
42 |
#### Show these roles
|
|
|
43 |
|
|
|
44 |
This setting allows you to control which users appear in this block. Users need to have at least one of these roles in a course to be shown in the block.
|
|
|
45 |
|
|
|
46 |
#### Show multiple roles
|
|
|
47 |
|
|
|
48 |
This setting allows you to control if users who have more than one of the roles configured above are listed once or multiple times in this block. If this setting is disabled, users will be only listed with the first role they have according to the global role sort order. If this setting is enabled, users will be listed within each of their roles.
|
|
|
49 |
|
|
|
50 |
|
|
|
51 |
### 2. Participants page
|
|
|
52 |
|
|
|
53 |
#### Show link to the participants page
|
|
|
54 |
|
|
|
55 |
By enabling this setting, a link to the participants page of the course will be shown within the block.
|
|
|
56 |
|
|
|
57 |
Please note: Even if this setting is enabled, this block only shows the link to the participants list if the user has the capability moodle/course:viewparticipants.
|
|
|
58 |
If the user does not hold this capability, a hint "Viewing the participants list is prohibited in this course" will be shown in the block.
|
|
|
59 |
See http://docs.moodle.org/en/Capabilities/moodle/course:viewparticipants for details on this capability.
|
|
|
60 |
|
|
|
61 |
|
|
|
62 |
### 3. Hiding the block
|
|
|
63 |
|
|
|
64 |
#### Hiding the block
|
|
|
65 |
|
|
|
66 |
By enabling this setting, the block can be hidden by users.
|
|
|
67 |
|
|
|
68 |
Important notice:
|
|
|
69 |
Disabling this setting will entirely remove the showing / hiding the block menu item. This means, that users cannot hide this block anymore, but on the other hand, blocks that are already hidden cannot be shown anymore, too. If you want to enable this feature, consider using the following function to reset the visibility for all "block_people" instances.
|
|
|
70 |
|
|
|
71 |
#### Reset visibility
|
|
|
72 |
|
|
|
73 |
By enabling this checkbox, the visibility of all existing "block_people" instances will be set to visible (again).
|
|
|
74 |
|
|
|
75 |
Please note:
|
|
|
76 |
After saving this option, the database operations for resetting the visibility will be triggered and this checkbox will be unticked again. The next enabling and saving of this feature will trigger the database operations for resetting the visibility again.
|
|
|
77 |
|
|
|
78 |
Fixed Behaviours
|
|
|
79 |
----------------
|
|
|
80 |
|
|
|
81 |
### 1. Links
|
|
|
82 |
|
|
|
83 |
block_people only allows to view the teacher's profile if the user has the capability moodle/user:viewdetails
|
|
|
84 |
See http://docs.moodle.org/en/Capabilities/moodle/user:viewdetails for details on this capability
|
|
|
85 |
|
|
|
86 |
block_people only shows a quicklink to the message system if the user has the capability moodle/site:sendmessage and if the Moodle message system is turned on ($CFG->messaging)
|
|
|
87 |
See http://docs.moodle.org/en/Capabilities/moodle/site:sendmessage for details on this capability and http://docs.moodle.org/en/Messaging for details on the messaging system
|
|
|
88 |
|
|
|
89 |
### 2. Roles sort order
|
|
|
90 |
|
|
|
91 |
block_people shows teacher role groups in the order defined in /admin/roles/manage.php. Please visit this settings page if you want to modify the sort order
|
|
|
92 |
|
|
|
93 |
|
|
|
94 |
Capabilities
|
|
|
95 |
------------
|
|
|
96 |
|
|
|
97 |
This plugin also introduces these additional capabilities:
|
|
|
98 |
|
|
|
99 |
### block/people:addinstance
|
|
|
100 |
|
|
|
101 |
This capability controls who is allowed to add a new people block to the Dashboard
|
|
|
102 |
|
|
|
103 |
### block/people:myaddinstance
|
|
|
104 |
|
|
|
105 |
This capability controls who is allowed to add a new people block to all other pages
|
|
|
106 |
|
|
|
107 |
|
|
|
108 |
Block placement
|
|
|
109 |
---------------
|
|
|
110 |
|
|
|
111 |
block_people is used ideally as sticky block and appears on all of your course pages at the same position
|
|
|
112 |
|
|
|
113 |
See http://docs.moodle.org/en/Block_settings#Making_a_block_sticky_throughout_the_whole_site for details about sticky blocks
|
|
|
114 |
|
|
|
115 |
|
|
|
116 |
Theme support
|
|
|
117 |
-------------
|
|
|
118 |
|
|
|
119 |
This plugin is developed and tested on Moodle Core's Boost theme.
|
|
|
120 |
It should also work with Boost child themes, including Moodle Core's Classic theme. However, we can't support any other theme than Boost.
|
|
|
121 |
|
|
|
122 |
|
|
|
123 |
Plugin repositories
|
|
|
124 |
-------------------
|
|
|
125 |
|
|
|
126 |
This plugin is published and regularly updated in the Moodle plugins repository:
|
|
|
127 |
http://moodle.org/plugins/view/block_people
|
|
|
128 |
|
|
|
129 |
The latest development version can be found on Github:
|
|
|
130 |
https://github.com/moodle-an-hochschulen/moodle-block_people
|
|
|
131 |
|
|
|
132 |
|
|
|
133 |
Bug and problem reports / Support requests
|
|
|
134 |
------------------------------------------
|
|
|
135 |
|
|
|
136 |
This plugin is carefully developed and thoroughly tested, but bugs and problems can always appear.
|
|
|
137 |
|
|
|
138 |
Please report bugs and problems on Github:
|
|
|
139 |
https://github.com/moodle-an-hochschulen/moodle-block_people/issues
|
|
|
140 |
|
|
|
141 |
We will do our best to solve your problems, but please note that due to limited resources we can't always provide per-case support.
|
|
|
142 |
|
|
|
143 |
|
|
|
144 |
Feature proposals
|
|
|
145 |
-----------------
|
|
|
146 |
|
|
|
147 |
Due to limited resources, the functionality of this plugin is primarily implemented for our own local needs and published as-is to the community. We are aware that members of the community will have other needs and would love to see them solved by this plugin.
|
|
|
148 |
|
|
|
149 |
Please issue feature proposals on Github:
|
|
|
150 |
https://github.com/moodle-an-hochschulen/moodle-block_people/issues
|
|
|
151 |
|
|
|
152 |
Please create pull requests on Github:
|
|
|
153 |
https://github.com/moodle-an-hochschulen/moodle-block_people/pulls
|
|
|
154 |
|
|
|
155 |
We are always interested to read about your feature proposals or even get a pull request from you, but please accept that we can handle your issues only as feature _proposals_ and not as feature _requests_.
|
|
|
156 |
|
|
|
157 |
|
|
|
158 |
Moodle release support
|
|
|
159 |
----------------------
|
|
|
160 |
|
|
|
161 |
Due to limited resources, this plugin is only maintained for the most recent major release of Moodle as well as the most recent LTS release of Moodle. Bugfixes are backported to the LTS release. However, new features and improvements are not necessarily backported to the LTS release.
|
|
|
162 |
|
|
|
163 |
Apart from these maintained releases, previous versions of this plugin which work in legacy major releases of Moodle are still available as-is without any further updates in the Moodle Plugins repository.
|
|
|
164 |
|
|
|
165 |
There may be several weeks after a new major release of Moodle has been published until we can do a compatibility check and fix problems if necessary. If you encounter problems with a new major release of Moodle - or can confirm that this plugin still works with a new major release - please let us know on Github.
|
|
|
166 |
|
|
|
167 |
If you are running a legacy version of Moodle, but want or need to run the latest version of this plugin, you can get the latest version of the plugin, remove the line starting with $plugin->requires from version.php and use this latest plugin version then on your legacy Moodle. However, please note that you will run this setup completely at your own risk. We can't support this approach in any way and there is an undeniable risk for erratic behavior.
|
|
|
168 |
|
|
|
169 |
|
|
|
170 |
Translating this plugin
|
|
|
171 |
-----------------------
|
|
|
172 |
|
|
|
173 |
This Moodle plugin is shipped with an english language pack only. All translations into other languages must be managed through AMOS (https://lang.moodle.org) by what they will become part of Moodle's official language pack.
|
|
|
174 |
|
|
|
175 |
As the plugin creator, we manage the translation into german for our own local needs on AMOS. Please contribute your translation into all other languages in AMOS where they will be reviewed by the official language pack maintainers for Moodle.
|
|
|
176 |
|
|
|
177 |
|
|
|
178 |
Right-to-left support
|
|
|
179 |
---------------------
|
|
|
180 |
|
|
|
181 |
This plugin has not been tested with Moodle's support for right-to-left (RTL) languages.
|
|
|
182 |
If you want to use this plugin with a RTL language and it doesn't work as-is, you are free to send us a pull request on Github with modifications.
|
|
|
183 |
|
|
|
184 |
|
|
|
185 |
Maintainers
|
|
|
186 |
-----------
|
|
|
187 |
|
|
|
188 |
The plugin is maintained by\
|
|
|
189 |
Moodle an Hochschulen e.V.
|
|
|
190 |
|
|
|
191 |
|
|
|
192 |
Copyright
|
|
|
193 |
---------
|
|
|
194 |
|
|
|
195 |
The copyright of this plugin is held by\
|
|
|
196 |
Moodle an Hochschulen e.V.
|
|
|
197 |
|
|
|
198 |
Individual copyrights of individual developers are tracked in PHPDoc comments and Git commits.
|
|
|
199 |
|
|
|
200 |
|
|
|
201 |
Initial copyright
|
|
|
202 |
-----------------
|
|
|
203 |
|
|
|
204 |
This plugin was initially built, maintained and published by\
|
|
|
205 |
Ulm University\
|
|
|
206 |
Communication and Information Centre (kiz)\
|
|
|
207 |
Alexander Bias
|
|
|
208 |
|
|
|
209 |
It was contributed to the Moodle an Hochschulen e.V. plugin catalogue in 2022.
|