Plugin that can be used for setting up an user manual (M3.6)

Plugin that can be used for setting up an user manual (M3.6)

by Franky Just -
Number of replies: 6

I was searching for a plugin that can be used for generating e.g. an user manual in the form of a FAQ. So that an admin can add FAQ's (CRUD) and show them in the main content area to users. More advanced features could be to categorize them, add permissions settings to it, in which context (global or course) to show them, filtering/sorting options, etc.. Such a plugin could be useful for other more similar purposes. In many programming systems (e.g. CMS) there are plugins which can do this, or you can modify them slightly to fit your needs. But as far as I have experienced Moodle, I'm in doubt if there is such a plugin that can be used or modified for this purposes. Sometimes I see in themes extra settingfiles added, which can be used in this way, but it's then for a limited number of items. But this is not very efficient, and I think this shouldn't be build into themes. If not available in the downloads directory, what would be the best way to set up such a plugin?

Average of ratings: -
In reply to Franky Just

Re: Plugin that can be used for setting up an user manual (M3.6)

by Franky Just -

I've looked deeper into the plugins directory, and the list of Moodle type plugins. I think it has to be then a local plugin. The plugin that seems in some way a basic starter is static pages. (https://moodle.org/plugins/local_staticpage). But this doesn't have any admin interface for CRUD actions, only static HTML. Surprisingly that there is not yet such a plugin as I want, I think myself it would be (very) useful. But it seems for now that there is little need for that in Moodle? 

In reply to Franky Just

Re: Plugin that can be used for setting up an user manual (M3.6)

by Hartmut Scherer -

Hi Franky,

Have you considered using the glossary module? 

With kind regards,

Hartmut

Average of ratings: Useful (1)
In reply to Hartmut Scherer

Re: Plugin that can be used for setting up an user manual (M3.6)

by Franky Just -

I've not yet tried glossaries, perhaps his could be for a user manual a good solution, I will try it out!

On a course page I've made a user tour,  this is indeed a part of the solution. Maybe it will work out sufficient in combination with an overall glossary.

In reply to Franky Just

Re: Plugin that can be used for setting up an user manual (M3.6)

by Franky Just -
I've also tried glossaries, but I ran into 2 issues that makes it for my purpose on first sight not sufficient enough:


  1. Enrollment issue: when set up within a course for every new or current student the information has to be automatically available (preferable with a link to the FAQ in the top navbar). This enrollment issue probably can be tackled by the auto-enrolment plugin in which this course (the FAQ-list) automatically will be added to all new users.
  2. Essentially glossaries stay organized 'as or within a course', and I want the FAQ to stay out of any content. An alternative is probably to put a more stand alone glossary on the startpage (for loggedin users). 
As a fall back the local static pages plugin can be used when there aren't too much items, which also do not change often. But as I have already noticed this plugin has no facilities to add items etc. with CRUD, and that's a pity.


In reply to Franky Just

Re: Plugin that can be used for setting up an user manual (M3.6)

by Hartmut Scherer -

Hi Franky,

You can tackle both issues easily with a course that I named "Site-Wide Resources" to which all users of our DE site have access to by default (cohort students; cohort faculty). New users are added to their respective cohort. If I set a glossary in "Site-Wide Resources", I can add a link to this glossary in the top navigation bar (e.g., Students > Site-wide Glossary). This link only works for logged-in users.  

Site-wide Glossary











With kind regards,

Hartmut

Average of ratings: Useful (1)
In reply to Franky Just

Re: Plugin that can be used for setting up an user manual (M3.6)

by Dave Sherwin -

Franky,

We have used glossaries for FAQ and made it a global glossary, so that that items would auto-link through the entire site.  This worked for us but now Moodle has the functionality of User tours.

With the addition of User tours, we have been using the tours that come with Moodle to explain the functionality of activities and the layout of courses.  Moodle.Net also has a User tours Database that you can download and use on your site. Plus Admin users are allowed to create and customize {User tours]] for their own site...

Average of ratings: Useful (1)