Forum Discussion
Rise Learning Journal / Notes
BETA distribution files Instructions for implementation further down the page under the heading BETA Version Release.
I've been working on a Learning Journal for Rise. I have an BETA version I'd like to share on SCORM Cloud.
The features we have included so far are:
- Comments persisted between sessions (SCORM 1.2 & SCORM 2004 3rd and 4th Ed)
- Save comments, associated with blocks individual blocks
- Comments are organised into topics/pages
- Edit existing Comments
- Delete Comments
- Print comments (to printer, or PDF is you have the required software installed)
- Export comments to Word (*.doc)
- Pagination (If comments exceed a defined number, they are split into pages)
There are some things that needs to be finalised which will not take a great deal of work to complete.
- Mobile compatibility
- WCAG 2.2 AA
What I'm looking for is a bit of community input, as I know people have wanted this feature for quite some time. This is my best guess of how somebody might use a learning journal, but would love to hear any other examples of how it could function, or additional useful features that could be included.
If you would like to check it out on SCORM Cloud. You can visit this URL: Rise Learning Journal on SCORM Cloud
Update (3rd December 2024)
I have continued to work on this project and it is now SCORM 2004 compatible. Again, it is using the cmi.comments_from_learner. Unfortunately I found a significant issue with the Articulate implementation of the SCORM 1.2 and 2004 comments. I am in communication with support after logging the issue. I am hoping I can convince them that the implementation is incorrect, and the base script is updated. In the meantime, I am applying a patch to the Articulate "WriteComment" function to ensure comments are stored correctly for SCORM 1.2 and SCORM 2004.
I have also made some cosmetic changes and updated the CSS for the HTML to ensure the application picks up the current Rise module theme (colours, fonts etc).
I've fixed a few bugs I have found along the way with regards to deleting journal entries, and editing journal entries when not on the page they originated from. This all appears to be working really well now.
My next priority will be working on the CSS to ensure it is mobile compatible. Once all of the HTML and CSS is finalised, I'll then work on the accessibility. I've been implementing aria attributes as I go along, but there is still some testing and development to be done on that side of things.
I will be looking to release this as a BETA to a handful of people early in the new year.
Update (9th December 2024) Accessibility
Started work on accessibility. Currently implementing and then will be looking to test using JAWS 2024 and NVDA over the xmas holiday period.
On track for BETA release Jan 2025.
Update (09 January 2025) Accessibility & refactoring
Still working on accessibility and refactoring. There is a little more work than first forecast. Yes, I know, you've never heard that from a developer before. I'm 50/50 as to whether I can get this out in January. It will depend on other work commitments, but I will keep this post updated.
I have decided to simplify the colour scheme and move away from using the defined "branding" colours inherited from Rise, as I was finding this a bit unpredictable with colour contrast, and so in the interest of ensuring the content has the best colour contrast, I'll be hard coding the CSS rather than using the CSS variables defined in Rise. I'll re-visit this in future.
Looking at the code, I need some serious refactoring as I think I found some redundancies and so need to delete any unused code that I added and then abandoned.
Oh, and Happy New Year.
Update (24 January 2025) Accessibility & refactoring
Almost ready for BETA release. Should be ready for release next Tuesday. Accessibility just about completed. I think I could spend another few days improving things, but I think this will be a good first release.
BETA Version Release
Contact: notes@rebusmedia.com
Minimum requirements:
- Rise course published SCORM 1.2 or 2004 (xAPI not currently supported)
- LMS Support for cmi.comments (TalentLMS cmi.comments implentation is not supported as the comments are not persisted between sessions).
Release Notes:
This is a BETA release, and is provided as is without any warranties and It should be used with caution and fully tested for your use case before considering for production.
If you do find bugs, please report them to notes@rebusmedia.com (include browser, LMS, device) and I'll release a fix as quickly as possible. This is a side project and so does come second to our day job which can be busy, and so you may need a certain level of patience. Fixes can be expedited for your use case through engagement of our services for time critical projects.
It has been tested on mobile, but not extensively (Google Pixel + iPhone).
Win/Chrome has been the browser used for development, and testing has also been performed on Win/Firefox and Win/Edge.
Features requests:
If you require any features that deviate from the BETA version, they will be considered on their merit, but can only be guaranteed for your own implementation through engagement for our services.
We have a long list of features that we would like to add if there is enough interest in the application and if it is viable.
Accessibility:
We made the decision to remove colors from the modal window theme to keep it simple and generic and accessible (high color contrast). The application has been tested with JAWS 2024 and is fully keyboard accessible and keeps assistive technology users informed of what is happening when interacting with the modal window. I'm always willing to make improvements to accessibility as a priority. Accessibility issues are treated as a bug and not a feature request.
Implementation:
- Publish your Rise course to either SCORM 1.2 or 2004
- Download the two files note.min.css and notes.min.js files to your computer.
- Extract your published Rise course to your computer and then copy the note.min.css and note.min.js files to the scormcontent\lib folder
- Open the scormcontent\index.html file in a simple text editor such as notepad and paste the following text just before the closing head element, which looks like this </head>.
<link type="text/css" rel="stylesheet" href="lib/notes.min.css"> <script type="text/javascript" src="lib/notes.min.js" data-notes-per-page="5"></script>It will look something like this:
// Excerpt of scormcontent/index.html starts window.__loadEntry = __loadEntry window.__loadRemoteEntry = __loadRemoteEntry window.__loadJsonp = __loadJsonp window.__resolveJsonp = __resolveJsonp window.__fetchCourse = __fetchCourse })() </script> <link type="text/css" rel="stylesheet" href="lib/notes.min.css"> <script type="text/javascript" src="lib/notes.min.js" data-notes-per-page="5"></script> </head> <body> <div id="app"></div> // Excerpt of scormcontent/index.html ends - You can adjust the data-notes-per-page="5" attribute to determine how many notes should be listed in the viewer, before the pagination (note navigation) kicks in.
- Save the scormcontent/index.html file
- It's important to get this bit right, as the LMS expects the imsmanifest file in the root of the zip file you are about to create. Navigate to the folder containing imsmanifest.xml and then select all (CTL+A) and then select archive/zip/compress depending on the software you use the terminology can be different. It must be a zip file though and the imasmanifest.xml file must be in the root of the zip file.
Update (28 January 2025) Print functionality improvement
After some user feedback, I have adjust the print functionality so that there is less chance of the student losing the course window during printing. When print is completed or cancelled, the print page closes and the user is return to the course window.
Update (30 January 2025)
Fix: Added functionality to handle learn.riseusercontent.com cmi.comments implementation. The cmi.comments implementation is incorrect on the LMS and requires the application to retrieve all comments and save to the LMS rather than appending to existing comments. This could cause memory issues if users add multiple long comments over time.
CSS: Improved CSS for mobile view (using full height of the screen to display the application.
Update (31 January 2025)
Bug: There is a known issue with TalentLMS. TalentLMS does not persist SCORM 1.2 cmi.comments between sessions. All comments are disregarded at the end of the session. For this reason, we cannot support TalentLMS unless TalentLMS changes the functionality of the SCORM 1.2 cmi.comments.
CSS: Improved CSS for mobile view. Supporting devices with a minimum screen width of 355px wide.
Could someone share the link from the original post and tutorial? I have worked with Learning Journal from Mike, but I want to try this one as well. Thanks!
The instructions to implement this are in the original post under the title "Implementation:"
Awesome work, very much appreciate all the effort & work.
I've been waiting for something like this for years!!! Have you shared the rebus js/css previously? Or is that what you will be sharing this week? I'm hoping to include this in my capstone project (due 02/02), but the timing is TIGHT! Thanks for sharing this great work!!!
SamHill - you are a rockstar!!!
Here is some feedback: I just added the css and js to my SCORM package and tested it out in TalentLMS. The note-taking functionality works as expected in the course itself 😃, however when I exit or complete the course, it is not retaining the notes.
The progress is saved in the LMS platform (completed or resume), but the notes have disappeared from the course. Have you encountered this? Is there a workaround?
You've done an amazing job and I think you'll be able to capitalize well with this solution - bravo!
Thank you! I can wait to use it as well.
SamHillHey there Sam. Just came across this and WOW! I've been down a rabbit hole trying to figure out a way to integrate a "digtial workbook" into RISE - everything from fillable pdf, to google doc, to https:/wobo.app to Storyline text input and nothing I have seen thus far is as easy and elegant as the solution you have built here. While it's not an interactive workbook like I exactly had in mind -- mostly I want to prompt the user with questions and different inputs and personal reflections -- this solution you have here could simplify things immensely. I am thinking I could prompt the user with onscreen text in the block instructing them what to input in the note. For me having the notes associated with a block rather than one big note is defintely the way to go for my use case. So I guess the quesion is can we implement it now? Where exactly are you in dev? I have a course going live March 1 and would love to give it a try and am also willing to put it out in the world. Our March 1 users are a small controlled group of pilot users so we have wiggle room with working out any kinks. How can I run with it and help in any way with your feedback/testing? Bottom line....I love it! I want it! Thank you so much for helping everyone take Rise to another level.
Hi CindyMcElhin363 I'd be really keen to get this in your project and iron out kinks. The BETA will be ready next week. I'll be updating this post with implementation. I'll be looking to distribute the BETA version for free to a handful of people willing to explore using it in a real project. Can you tell me which version of SCORM you use?
SamHillAwesome. I can use either version. My platform running the Rise courses is a wordpress site using Paid Memberships Pro and LifterLMS with GrassBlade LRS/xAPI Companion.
Hey Sam. I was a long time user of Mike's learning journal. I'm working on a build that requires a journal, and found my way to you just now after following some support threads from Mike's version. Your work is fantastic—it's really exciting—and I can't wait to start using it! Can you please include me in the BETA release? I'll be watching your full video shortly and reading your release notes, so my question may very well already be answered, but are you able to control/select the blocks that show the widget? Thanks so much for sharing this :-) Melanie
Hi MelnieHalliwell, the BETA version is now available. See the original post for a link to the files and instructions.
Hi melaniehalliwell thanks for the comments. The component currently attaches to certain types of blocks and cannot be attached to specific blocks that the author chooses.
I will look into this though as it is possible. For example, adding a specific string "{{notes-button}}" at the top of a block could be used as a directive to insert the component. This was one of my very early experiments, but I opted for automatically inserting on certain block types. I will consider this as a more advanced implementation.
Thanks for the feedback!
Hi Sam,
I love your learning journal!! I have used other types in my Rise courses but this one definitely seems to be significantly better than any I have seen. I love that you are also focusing on accessibility because many of my clients require that. I don't have any feedback except that I love it! I love that you have the icon next to each block. I love that you can edit and delete comments. And most importantly I love that it should save their inputs and they can print out a PDF or Word doc at the end of the Rise course. Please let me know when the Beta is ready. I would love to be a part of that testing. And I completely agree you should be paid for all the development time you have put into this. Keep up the amazing work!
Hi CarrieAlbin-b90, the BETA version is now available. See the original post for a link to the files and instructions.
Hi Sam,
This is absolutely amazing. It is exactly what I need for my course. My question is, would it be possible to create this not for just one course but for many? I have 14 RISE courses (each is a lecture to me) in my online class. My LMS combines them into one course for me. I would love to have my students take each lecture with their notes and have them added to a course notebook at the end of all of my 14 lectures, so they have their own guide. Can you imagine that this would be possible at all?
Hi AmyGtt I'd need some more information on the structure before I can answer this, but will provide some information on how it does work.
The Learning Journal makes use of SCORM to store the notes, therefore, notes are associated with an individual SCORM package. For example, when you publish a Rise course to the SCORM specification.
It sounds like your LMS provides a means to group together a number of SCORM modules to present as a single course. In this instance, there would be individual notes for each of those SCORM modules. Notes taken in SCORM module X would not be available in SCORM module Y. The reason being, the data is not shareable in SCORM. SCORM does not provide a means to share data between modules and they are only self aware.
We will be looking at ways this could be enhanced in future to support accessing data across different modules, but this would require a 3rd party database, which would incur costs.
We're keeping it simple for this first iteration.
I'm looking forward to releasing the BETA later this month. I'll let you know when it is available.
ok, thank you very much for the reply.
Hi Sam
Thanks for tackling this issue.
Have looked at the video and this is exactly the solution that we need and have been unsuccessfully looking for. Have had to look at other less viable options using H5p or storyline notepad lightbox with limitations regarding saving the notes, grouping them etc.
Minor issue may be the ability to print selected parts or export selected parts as looks like prints/saves all each time. Would the facilitator have the ability to review the notes created in any way.
Would be happy to get involved in testing and thanks for this, commercial approach makes sense as this would be a significant value add on our side.
Hi JonathanAspelin, the BETA version is now available. See the original post for a link to the files and instructions.
