..  _introduction:

What does it do?
================

The extension adds one content element, the study plan. It shows the course of
a study programme: the semesters side by side, and below each semester the
modules taught in it, with their credit points and notes. Visitors highlight
the modules of a category with a filter above the plan, open the description
of a module in a dialog, and read every semester as an accordion on a phone.

Editors enter the semesters and their modules as inline records of the content
element, so the plan lives where it is shown, usually on the page of the study
programme. See :ref:`integrator-study-plan` for the fields and
:ref:`styling` for the classes a site package styles the plan through.

..  _third-party-icons:

Third-party icons
-----------------

The SVG icons below :file:`Resources/Public/Icons/`, except
:file:`Extension.svg`, are `Font Awesome Free <https://fontawesome.com>`__
icons by Fonticons, Inc., licensed under the `Creative Commons Attribution 4.0
International license <https://creativecommons.org/licenses/by/4.0/>`__. The
notice :file:`Resources/Public/Icons/LICENSE-font-awesome.txt` lists every file
with its Font Awesome name and the changes made to it. The controls of the
study plan draw the shared icons of :guilabel:`academic_base`, which lists them
in its own notice.

This manual shows the icon of the content element from
:file:`Documentation/Images/Icons/study-plan.svg`, a copy of
:file:`Resources/Public/Icons/plugin/study-plan.svg`, the Font Awesome icon
`table-list`, drawn in a fixed grey instead of the colour of the surrounding
text, so that it reads on a light and a dark page alike.