Added additional caching improvements and testing. Should be ready for review.
This is a lot more clear to see with 📌 [PP-1] Convert course navigation block to SDC Active
It seems to me that if a course that has Free Navigation turned off, there are two ways to handle backwards navigation:
Option A: disallow any course navigation, including backwards nav, until the course is finished and graded; or
Option B: allow backwards navigation, but when visiting a previous question, forwards nav should also be allowed up to the highest answered question +1.
Not really sure which of those two options makes the most sense, or even if that needs to be a sub-setting of the Free Navigation setting so course creators can decide based on their individual context.
Will do additional code cleanup and optimization, meanwhile any feedback on the looks and function is welcome.
WIP commit - includes a number of navigation improvements:
- adds single-directory components (SDC) for layout and styling.
- displays all but the current lesson as collapsed accordion lists, for compactness and better visual progress display.
- removes the link url from activities that are not available to visit, based on the course-level Free Navigation setting, or if the user is revisiting a completed course.
- improves the course navigation caching/placeholder logic, with appropriate cache lifetimes based on per-user and per-lesson display options.
- adds styling to each activity to indicate current / answered / unanswered activities.
- adds activity scores on course revisit.
@btriest start_link is one of the new SDC components, it may be that you need to clear all caches and see if that gets rid of the error.
We can just separate the results link from the status indicator and have them next to each other.
Simplified code examples and added references to Drupal docs
I was thinking just to set up a basic SDC card component, possibly with a default generic course image. Then site builders can customize in their theme or through UI Suite. It can live in a course_card directory under /components.
Not sure if you were implementing Workspaces yet, but I tried editing lessons and courses in a Staging workspace and on saving them got an error: Return value must be of type int, false returned.
A small "nice to have" when throwing an error trying to unpublish a lesson/activity, would be to list the courses/lessons that it is being used in. Currently the error message says, eg: "This activity cannot be unpublished as it is a part of at least one published lesson" but there is no easy way to find out what lesson(s) it is in.
Sorry, I didn't see your video at first -- it looks like a permissions issue. Check that the account that you're logged into has the necessary permissions:
- User role permissions: admin/people/permissions -- check "Administer LMS" permission
- Group permissions: admin/group/types/manage/lms_course/permissions -- admin should have all permissions
Clarified instructions for resetting student progress
You need to be in the course's admin view in the Students tab:
LMS menu > Courses > click on the course's name > click on the Students tab
Then you can select students with the checkboxes, and in the Action dropdown select 'Reset course progress'. Then click 'Apply to selected items'
Ok after much flailing on my part 😅 it is now passing testing. Remember to clear caches for the new components to be discovered.
WIP: Works but failing testing, investigating...
I've found a few other components that can be targeted for SDC conversion. Here's my suggested order of operations:
- Set up SDC and convert simple components, see
📌
Set up SDC and convert simple components
Active
- Lesson Timer
- Admin Toolbar icon
- Course Status Indicator
- Start Link field
- Course Results display
- Courses Listing (use cards)
- Activity-Answer display (cards with defined regions)
- Course Navigation - see 📌 [PP-1] Convert course navigation block to SDC Active
Removing "PP-1" as 📌 Update legacy themes Active has landed, and adding as a child issue of 📌 Improve general appearance Active
Improve instructions for manually adding students
Improve class management instructions and overall formatting
As discussed in a couple of other places, let's consider transitioning the LMS module to Single-Directory Components (SDC) plus full compatibility with UI Suite, to modernize and simplify all front-end development. This will prevent the need for the LMS module to have to provide any theming of its own, while exposing components, props, and slots to front-end designers to easily manage the look & feel of all of the LMS components.
In practical terms, this would mean transitioning the existing /templates, /css, and /js into a single /components directory, plus updating any code references to them. Then we can also add any other components that would be helpful for the styling of courses, lessons, activities, navigation, progress tracking, messaging, etc.
The current components that need to be adapted include:
- Lesson Timer
- Course Navigation block (currently being modified: 📌 Update legacy themes Active )
- Start Link field
- Admin Toolbar icon
Let me know if we're in agreement on this, or if it needs further discussion. If we have a consensus, I propose to create a child issue to move existing components to SDC, and then add separate child issues as needed for full UI Suite compatibility.
@graber is the Subgroup (Graph) module a useful addition still? We could list it as optional and describe what features it can make available to LMS.
Also considering adding a section on available sub-modules and their uses, although it's also covered on the project page. But if life has taught me anything, it's that people don't read what you tell them, so often covering it in multiple places is the best way to get the message across sometimes! 😂
Yes I think we can close this, thanks for all the help and feedback!
I have a use-case where multiple people will be collaborating on a course, so having the ability to save a draft for discussion would be highly desirable. Then it can be published when there's consensus on the content.
This is somewhat related to 🐛 Unexpected behaviours when editing lessons Active
Overall the ability to continuously improve on courses, even while students are actively taking them, seems like an important feature of an LMS platform. Not that it's necessarily easy to achieve!
Activities could be styled by score, similar to conditional formatting in a spreadsheet. Also would be good to style unanswered activities.
It would be nice if the lessons that aren't the current lesson could be collapsed also, if there's a long course it will be a huge block otherwise.
I've drafted a first version of a Plugin Developer's Guide → : instructions for creating custom Activity-Answer plugins
Feedback is welcome on errors, omissions, and any areas that need better clarity.
I've added global namespace indicators before every global function call -- I think I got 'em all!
field with number of phrases required to score max
I'm not sure if I understand the usefulness of this, to my mind a teacher would only add the match-phrases that they wanted to see in the student answer, so if they get all of them they get 100% score. But maybe you're seeing a use case that I'm missing where this would be needed?
phrase variants so any of the variants will count as a phrase found (phrases setting textarea: each row is a phrase and variants separated by a pipe)
Excellent idea! Already included in the plugin from the beginning. 😁
Allow 1 or 2 letter difference when searching with feedback like "phrase found but you have a typo"
I would LOVE to add this feature, but couldn't find a way to do it that isn't super resource-intensive. Can you suggest a method?
I've taken a swing at adding some module documentation. I thought it would be best to divide the docs into 3 separate guides:
- Course Creator's Guide → : instructions for end-users
- Developer's Guide → : detailed developer's guide to the module's architecture and functionality
- Plugin Developer's Guide → : instructions for creating custom Activity-Answer plugins
I've added appropriate WIP disclaimers and placed every page in 'Needs Review' status. Whoever is familiar with any part of this, I'd love to get your feedback on errors, omissions, and any areas that need better clarity.
In particular I'm pretty fuzzy on Class groups, what they are for, whether students can be enrolled in both a Course and a Class, and if there are good ways to manage bulk enrolment etc. So this page → needs particular attention.