mcCourseBookPlugin

/config

• forms.yml - settings of Topic creation form
• routing_*.yml - routing settings for displaying Topics in frontend and their administration in backend

/doctrine

• schema.yml - Topic database table definition

/i18n

Translations of common texts related to Topics.

/lib

Libraries for handling Topics.

/model

• ttsParsingTools.class.php - functions that execute various Python scripts on “Topic save” action

  Important methods:

  ttsParsingTools::validateHTML($html) - validation of HTML content of Topic

  ttsParsingTools::updateInlineFormulas($output) - adds additional attributes to each span with *inline-formula* or *chemical-formula* class:

  • name - original formula in better formating for display
  • alt - textual representation of formula for reading

/model/doctrine

• PluginTopic.class.php - Topic entity functions, e.g. save() or __toString()
• PluginTopicTable.class.php - Topic database functions

/modules

Contains actions and relevant templates for both frontend and backend. E.g. Topic action executeShow() in /mcTopic/actions/actions.class.php and its template in /mcTopic/templates/showSuccess.php

/web

Contains CSS definitions and images needed for Topic display and navigation.

• /js/courseBookScripts.js - contains Javascript functions needed for correct display of formulas and solutions.