diff --git a/content/modules/Screenshot From 2025-01-16 10-19-22.png b/content/modules/Screenshot From 2025-01-16 10-19-22.png new file mode 100644 index 0000000000000000000000000000000000000000..6a0a6d7765f2b6230835c9263ac137d4d38832a1 Binary files /dev/null and b/content/modules/Screenshot From 2025-01-16 10-19-22.png differ diff --git a/content/modules/_index.md b/content/modules/_index.md index aac4ea71d076c770b0854de60e4e568fac654aa6..f327e0f301ef427761a91b9d264cbdca077af764 100644 --- a/content/modules/_index.md +++ b/content/modules/_index.md @@ -8,6 +8,6 @@ Modules are how activities are grouped in MPyT. A module can have one or more co You can select a module from the list of modules shown on the left hand side of the main interface. You can filter this list using the search box (shown above the module list) - you can use either the module name or its code for this purpose. Selecting a module is as simple as clicking on its name. -[!Main interface](images/interface.png) + diff --git a/content/modules/activities/_index.md b/content/modules/activities/_index.md index 3be6785d42d7602af283c336b2bacd97a08eed1c..ddfd5eb430b83b913b8e6f0f23324a2f20a21ef8 100644 --- a/content/modules/activities/_index.md +++ b/content/modules/activities/_index.md @@ -6,16 +6,23 @@ Activites are the things students are expected to _attend_ for a module. These a ## Activities + + | Name | Description | Example | | ---- | ------------------------------------------ | ------- | | Label | The name of the activity (student facing) | Computing Concepts | | Type | The type of activity (lecture, online workshop, etc...) | Lecture | +| Sequence Notes | Information relating to when this activity should be scheduled | After induction | | Duration | The length of **each** session (in hours) | 2 | -| Week Range | The weeks this activity will run in | 1-5,7-9 | -| Weeks | The total number of weeks the activity runs for (automatically calculated) | 6 | +| Week Range(s) | The study-block weeks this activity will run in | 1-5,7-9 | +| Week Count | The total number of weeks the activity runs for (automatically calculated) | 6 | +| Staff per Session | How many staff should be attached to each session? | 1 | +| Students per Group | How many students should be in each session? | 15 | -**TIP** If an activity does not need to be split (ie, there is one iteration required) leave the student count **blank** - the tool should show `(everyone)` +**TIP** If an activity doesn't need to be repeated, leave students per group **blank** - the tool should show `(everyone)` ## Mangaging Iterations -Once an activity has been created, you need to create [iterations](iteration) to tell the tool which staff and rooms should be attached to the activity. If you do not do this, the activity will **not** be scheduled. +Once an activity has been created, you need to create [iterations](iteration) to tell the tool which staff and rooms should be attached to the activity. If you do not do this, the activity will **not** be scheduled. + +The tool will try to calculate the required iteration count based on the students attached to the module, and the provided 'students per group' if the number of iterations does not match, a warning triangle should be displayed next to the activity. diff --git a/content/modules/activities/images/iter_dup.png b/content/modules/activities/images/iter_dup.png new file mode 100644 index 0000000000000000000000000000000000000000..e857679fca6424e42171d53ca3d50d6697afcb15 Binary files /dev/null and b/content/modules/activities/images/iter_dup.png differ diff --git a/content/modules/activities/images/iter_dup_dialog.png b/content/modules/activities/images/iter_dup_dialog.png new file mode 100644 index 0000000000000000000000000000000000000000..c240d57cd9448087f93ec0b79cf87921d3649356 Binary files /dev/null and b/content/modules/activities/images/iter_dup_dialog.png differ diff --git a/content/modules/activities/images/win_activity.png b/content/modules/activities/images/win_activity.png new file mode 100644 index 0000000000000000000000000000000000000000..e9f7343e1be13e66b940e53bf44718cbfade406b Binary files /dev/null and b/content/modules/activities/images/win_activity.png differ diff --git a/content/modules/activities/images/win_iters.png b/content/modules/activities/images/win_iters.png new file mode 100644 index 0000000000000000000000000000000000000000..da445f834a360aad4a23172bf9302e6f7181749d Binary files /dev/null and b/content/modules/activities/images/win_iters.png differ diff --git a/content/modules/activities/images/win_iters_validate.png b/content/modules/activities/images/win_iters_validate.png new file mode 100644 index 0000000000000000000000000000000000000000..292fe4c483718b4336df6b29e797f3b579b5a8f1 Binary files /dev/null and b/content/modules/activities/images/win_iters_validate.png differ diff --git a/content/modules/activities/iteration.md b/content/modules/activities/iteration.md index dd16b52a007fb63472a7fce89562f779d7e82d0e..5981e40f295a3f09af31a617549b9ad47033b24a 100644 --- a/content/modules/activities/iteration.md +++ b/content/modules/activities/iteration.md @@ -4,20 +4,37 @@ title: Managing Iterations Sometimes, an activity must be run in multiple _iterations_ with a small number of students in each group. MPyT deals with this by treating all activities as consisting of iterations. For large activities like lectures, we create a _single_ iteration of the activity. -## Creating a new iteration + -To create a new iteration, select an _activity_ in the interface. The activity will be highlighted in a different colour. Once the activity is selected click on the 'edit' button to show the iteration planner. +### Student Groups -**SCREENSHOT OF ITERATION PLANNER HERE** +This area lets you calculate how many groups are required based on the student counts. The tool cannot currently warn about allocations based on individual courses - this will assume all students on the module are the same (therefore, be careful if you need to allocate iterations by course). + +| Name | Description | +| ---------- | ------------------------------------------------ | +| Group Size | How many students should be allocated per group? | +| Iterations needed | Based on the above number and projected students attached to this module, how many iterations do we need? | +| Iterations planned | Number of iterations planned (on the next tab) | + +### Staffing + +| Name | Description | +| ---------- | ------------------------------------------------ | +| Staff per session | How many students should be allocated per iteration? | +| Required | Based on iterations, and number of staff needed how many 'slots' need planning for | +| Allocated | Number of staff currently attached | + +This section works in the idea of 'staff slots' -- the number of iterations and staff required per iteration. ## Designing the iterations -For a large activity, like a lecture, you can ignore most of the first page and leave them as the defaults. -For activites which must be split into smaller groups, the group sizes and number of staff required can be set on this page. +Based on the 'planning' tab you should have a reasonably good idea of how many iterations will be required. For a large activity, like a lecture, you can largely ignore most of the first page and leave them as the defaults. + +You can then decide who should be attached to the iterations and how many iterations to run on the second tab, 'iteration(s)': -## Creating the iterations + -The second tab lets you create iterations for your activity. Select the _add_ bottom right of the iterface to create a new iteration. You can then edit the table to update this iterations details (such as providing a name and remarks for planning). +You edit this page in much the same way as the activities page. Use the buttons at the bottom to add and remove iterations as required. On the bottom right, a total count of currently planned iterations is shown. ### Assigning Staff Staff can be attached to an iteration by clicking on the _staff_ cell for that iteration. A window showing the available staff should pop up. If a staff member has multiple contracts, all the contracts available for scheduling will be listed seperately. Click on the tick box next to a staff member's name to assign them to this iteration. You can assign as many staff as required for a session as needed for this session. @@ -30,11 +47,19 @@ Room allocation works the same way as allocating staff. Click on the room cell f You can check room allocations using the [Reports]() feature. ### Remarks -Remarks can be used to communicate anything extra to the timetabling team. We use this for communicating things which the system cannot automatically process (for example, specialist requirements or courses when allocating iterations via course). +Remarks can be used to communicate anything extra to the timetabling team. We use this for communicating things which the system cannot automatically process (for example, specialist requirements or courses when allocating iterations via course). Please talk to your timetabling contact about what works best in this field for them. ## Duplicating Iterations -Sometimes, it is neccerary mass-create duplicate iterations (for example, for assessments). You can *right click* on a row to duplicate entries, the system will prompt you for a number of duplications to create. +Sometimes, it is neccerary mass-create duplicate iterations (for example, for assessments). You can *right click* on a row to duplicate entries: + + + +The system will then prompt you for how many iterations to create, using the one you selected as a template: + + + +(thank you to Faye and Brian for requesting this feature). ## Copying and Pasting iterations diff --git a/content/modules/images/win_activity.png b/content/modules/images/win_activity.png new file mode 100644 index 0000000000000000000000000000000000000000..e9f7343e1be13e66b940e53bf44718cbfade406b Binary files /dev/null and b/content/modules/images/win_activity.png differ diff --git a/content/modules/report_module_activity.png b/content/modules/report_module_activity.png new file mode 100644 index 0000000000000000000000000000000000000000..6aea99c37195e78e8eecc3e77ff206ac372ff2d5 Binary files /dev/null and b/content/modules/report_module_activity.png differ diff --git a/content/modules/rpt_module_staff.png b/content/modules/rpt_module_staff.png new file mode 100644 index 0000000000000000000000000000000000000000..39f5236b5069000d2de865b2d82e6e316d47e2da Binary files /dev/null and b/content/modules/rpt_module_staff.png differ diff --git a/content/modules/rpt_space_util.png b/content/modules/rpt_space_util.png new file mode 100644 index 0000000000000000000000000000000000000000..b3e95e1866dcff973d8217e1c5e17d20a83f6222 Binary files /dev/null and b/content/modules/rpt_space_util.png differ diff --git a/content/modules/rpt_staff_usage.png b/content/modules/rpt_staff_usage.png new file mode 100644 index 0000000000000000000000000000000000000000..3d89b636e61ebd85717a186536145d1085588a10 Binary files /dev/null and b/content/modules/rpt_staff_usage.png differ diff --git a/content/modules/win_activity.png b/content/modules/win_activity.png new file mode 100644 index 0000000000000000000000000000000000000000..e9f7343e1be13e66b940e53bf44718cbfade406b Binary files /dev/null and b/content/modules/win_activity.png differ diff --git a/content/modules/win_activity_error.png b/content/modules/win_activity_error.png new file mode 100644 index 0000000000000000000000000000000000000000..122416f176c36749c2d1be70869178f43677a5d7 Binary files /dev/null and b/content/modules/win_activity_error.png differ diff --git a/content/modules/win_iters.png b/content/modules/win_iters.png new file mode 100644 index 0000000000000000000000000000000000000000..da445f834a360aad4a23172bf9302e6f7181749d Binary files /dev/null and b/content/modules/win_iters.png differ