.. include:: ../../variables.rst

.. _training.setup:

Training Setup
==============

Training Setup is where an administrator builds the lessons your team sees
in the :ref:`Training<training>` module. Each account has its own set of
lessons, so you can tailor the wording, examples, and even the pictures to
how your organisation works.

To open it, go to :blue:`Account` | :blue:`Advanced` |
:blue:`Training Setup` in the sidebar.

.. figure:: /images/PLACEHOLDER-training-setup.png
   :align: center

   TODO screenshot: the Training Setup page with the moment-method setting,
   the Observer / Author tabs, and the lessons table.

|br|

Account Setting
---------------

At the top of the page, ``Hand hygiene moments observed`` sets how many WHO
moments your observers record per observation. This drives the default
content for the *5 Moments* lesson. Choose one of:

* ``2 moments — entry / exit``
* ``4 moments — WHO 1–4``
* ``5 moments — full WHO 1–5``

The setting saves as soon as you change it.

Choosing a Track
----------------

The ``Observer Track`` and ``Author Track`` tabs switch the table below
between the two tracks' lessons. The count beside the table title tells you
how many lessons that track has.

Page-Header Buttons
-------------------

* ``Generate defaults`` — fills the account with the bundled starter set of
  lessons in one step. This is available only while the account has no
  lessons yet, so it cannot overwrite lessons you have already written. It
  is the quickest way to get started.
* ``New Lesson`` — opens the lesson editor with a blank lesson.

The Lessons Table
-----------------

Each row is one lesson in the currently selected track:

* ``#`` — the lesson's position in the track.
* ``Title`` — the lesson title, with its subtitle beneath.
* ``Module`` — the lesson's short internal name.
* ``Min`` — the estimated reading time in minutes.
* ``Active`` — ``Yes`` when the lesson is visible to learners, ``No`` when
  it is hidden.

The two icons at the end of each row let you ``Edit`` the lesson or
``Delete`` it (after a confirmation prompt).

.. _training.setup.editor:

Editing a Lesson
----------------

Choosing ``New Lesson`` or the edit icon opens the lesson editor.

.. figure:: /images/PLACEHOLDER-training-lesson-editor.png
   :align: center

   TODO screenshot: the lesson editor showing the lesson fields and the
   Sections builder.

|br|

The top of the editor sets the lesson's basics:

* ``Track`` — whether the lesson belongs to the Observer or Author track.
* ``Module slug`` — a short internal name for the lesson.
* ``Position`` — where the lesson sits in the track order.
* ``Estimated minutes`` — the reading time shown to learners.
* ``Title`` and ``Subtitle`` — what learners see in the track list.
* ``Active — visible to learners`` — turn this off to hide a lesson while
  you are still working on it. Only active lessons appear in the Training
  module.

Building the Content
^^^^^^^^^^^^^^^^^^^^

A lesson is made of one or more **sections**. Click ``Add section`` to add
one. Each section has an optional heading and a body you write in simple
Markdown formatting (``**bold**``, ``*italic*``, ``- list``, and
``[link](url)``). Use the up and down arrows to reorder sections, and the
remove icon to delete one.

To add a picture, click ``Insert image`` in a section's toolbar and choose
a file. |APPNAME| uploads it and drops a reference into the section for you.

When you are finished, click ``Save lesson``. The ``Delete`` button in the
editor footer (shown only when editing an existing lesson) removes the
lesson.

.. note::

   There is no separate "publish" step. A lesson becomes visible to
   learners as soon as it is marked ``Active`` and saved.