LernHive Moodle Core handbook

What this plugin does

LernHive Moodle Core handbook adds step-by-step handbooks for Moodle's own features to the LernHive Help Hub, for example courses, enrolments, quizzes and the gradebook. Each handbook links to its MoodleDocs source and, where LernHive offers one, starts a guided tour on the matching Moodle page. Site administrators can add handbooks of their own for the processes and roles of their site.

Who this is for

Learners and managers (reporting line) do not reach the Help Hub.

Core concepts

• Help Hub: the page LernHive Handbook, opened with Help in the launcher. Its tabs are LernHive (handbooks of the LernHive plugins), Moodle Core and Custom configuration.
• Moodle Core handbook: a handbook for a Moodle core feature that comes with this plugin, in English and German. It cannot be changed on the site.
• Custom handbook: a Markdown file (.md) a site administrator uploads. It appears in the tab Custom configuration.
• Tour: a guided LernHive tour on a Moodle page, provided by LernHive Onboarding.

Journeys by role

Site administrator: add custom handbooks

1. Write one Markdown file per handbook, saved as UTF-8 with the extension .md. Start it with a heading, for example # Onboarding new trainers, or with a title block:

   ---
   titel: "Onboarding new trainers"
   ---

Add a section ## Overview (or ## Purpose) whose first paragraph summarises the handbook; the Help Hub shows it on the tile.

1. Go to Site administration → Plugins → Local plugins → LernHive → LernHive Help.
2. Add the files to Markdown handbooks by drag and drop or with the file picker.
3. Select Save changes. The message Custom handbooks were saved. confirms it.
4. Check the result in Help (launcher) → Custom configuration.

The handbooks you uploaded earlier stay in place when you save the page again.

Site administrator: update or remove a custom handbook

1. Go to Site administration → Plugins → Local plugins → LernHive → LernHive Help.
2. To update a handbook, delete the old file in Markdown handbooks and upload the new version. To remove a handbook, select the file and delete it.
3. Select Save changes.

Platform administration: read a Moodle Core handbook

1. Open Help in the launcher.
2. Choose the tab Moodle Core. Narrow the tiles with Search handbooks…; the search covers the full handbook text.
3. Open a tile. The handbook shows its steps; below it you find Open original in MoodleDocs and, where available, one or more buttons Start user tour: ….
4. Start user tour: … opens the Moodle page of the tour and starts it.

A handbook shown in another language than yours carries the badge English only or German only.

Platform administration: read custom handbooks

1. Open Help in the launcher and choose the tab Custom configuration.
2. Open a tile to read the handbook. If no handbook has been uploaded yet, the tab shows No custom documentation yet; site administrators also see a link LernHive Help to the upload page there.

Trainer: read a handbook and start a tour

1. Open Help in the launcher.
2. Choose Moodle Core, open a handbook and select Start user tour: … to practise the step directly in Moodle.
3. Custom handbooks of your site are in Custom configuration.

Settings that matter

The plugin has no settings. LernHive Help is a management page for site administrators. Access is controlled by permissions:

A trainer with only a course role does not see Help in the launcher until a site administrator assigns the system role LernHive Trainer (or another role with View LernHive support).

Limitations

• The Moodle Core handbooks are fixed per release and cannot be edited on the site. Describe site-specific variations in a custom handbook.
• Moodle Core handbooks exist in English and German. Readers with another language see the English version with the badge English only.
• Open original in MoodleDocs opens the German MoodleDocs page the handbook was derived from, also from the English version.
• The handbooks are not updated from MoodleDocs automatically; they were checked against Moodle 5.2.
• Tour buttons appear only on Moodle Core handbooks, only when LernHive Onboarding is installed, and only for LernHive tours of the matching Moodle page. Manually created site tours are never offered.
• Custom handbooks:
  • Only .md files can be uploaded, within the site's maximum upload size. Images cannot be uploaded, and relative image references are not displayed.
  • Every handbook is shown to everybody who can open the Help Hub, in every language. There is no targeting by role or language.
  • Of the title block, only titel (or title) is used; other keys have no effect. Use flat key: value lines only, no lists or nested blocks.
• LernHive Help is only available to site administrators.

Troubleshooting

Screenshots

No screenshots yet.