Forum .LRN Q&A: Help Section in .LRN
The aDeNu group (UNED) is working on a Help Section for .LRN. Ludivine Martin, our usability specialist, is carrying out this task and she's doing a great job (kudos to Ludi :).
The first step has been to investigate how other LMSes implement the help and which type is the most convenient. The outcomes have been put together in 2 documents which I've uploaded to the file-storage:
- LMS Help Sections - Comparison (http://www.openacs.org/storage/file?file%5fid=1475548)
- Introduction to Embedded Help and Examples for .LRN (http://www.openacs.org/storage/file?file%5fid=1475551)
We hope you'll find them interesting.
I think these items can be easily implemented with the new template procedures that allow adding headers and footers to a page, along with the existing user message feature, and current embedded form help. We just need someone to write the help text!
Also for a "help" section, I have been thinking that using the existing /doc/ directory makes the most sense. It is already there and allows a consistent place to store package specific documentation.
I think these items can be easily implemented with the new template procedures that allow adding headers and footers to a page, along with the existing user message feature, and current embedded form help.
Exactly. That's what we want to use :).
We just need someone to write the help text!
This study was the first step. Next ones will be:
- Choose a HTML implementation for embedded form help that's compliant with WCAG
- Identify forms, pages and portlets that need help
- Write the help (in english first)
- Implement it
For the help section, we'd rather put it in "/help", sounds more intuitive. The other reason is that despite that the official doc will be now in the wiki, IMO the "/doc" location should be reserved for the package technical documentation. I wouldn't put user help and tech doc in the same place.
And speaking of help, any help would be appreciate when the implementation step comes :).
something like filename.en_US.adp ? We'll have to use someting like that.
I am very impressed with these reports. I am hopeful we will have a good comprehensive way to do help finally.
- separete area in the browser
- pop up window
- tooltip (with/without ajax)
- util_message_bar based solution
With page_order I defined the order of help messages. And you can use the translation toggle to display and translate help messages as well.
Thanks for the reference
I'm a new worker in Innova group (UNED). Firstly, congratulation for the document about concepts and different types of helps. I think that it's a great idea.
This morning we were talking about a help section and Raul Morales showed us about this thread. Can you or any other member of aDeNu tell us the current status of this project?
Thanks for the congrats, I'll transmit to Ludivine Martin who's the author of those documents.
To answer your question, unfortunately this "Help section" project is on hold and we don't have a schedule yet for it.