function opigno_tincan_question_type_help in Opigno TinCan Question Type 7

Implements hook_help().

File

./opigno_tincan_question_type.module, line 70

The main module file which contains the main drupal hooks.

Code

function opigno_tincan_question_type_help($path, $arg) {
  switch ($path) {
    case 'admin/help#opigno_tincan_question_type':

      // --- The ABOUT section.
      $output = '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The Opigno TinCan Question Type module adds a new question type to the quiz module. With this new question type, you will be able to upload a TinCan Package and use it as a question inside a lesson. More information can be found on the !module_page.', array(
        '!module_page' => l(t('module page'), 'https://www.drupal.org/sandbox/amermod/2705191'),
      )) . '</p>';

      // --- The USES section.
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Create a new question') . '</dt>';
      $output .= '<dd>' . t('When you create a new question, you will be able to choose the TinCan Package type of question. Then, you will be asked to choose a title and to upload a TinCan Package. You can find some on the !tincan_packages_site.', array(
        '!tincan_packages_site' => l(t('TinCan Website'), 'https://tincanapi.com/download-prototypes/'),
      )) . '</dd>';
      $output .= '<dt>' . t('Answer a TinCan Question') . '</dt>';
      $output .= '<dd>' . t('To answer a TinCan Question, you just have to start the lesson that contains the question previously created. The TinCan Package will appear in an iFrame.');
      $output .= '<dt>' . t('Get the score') . '</dt>';
      $output .= '<dd>' . t('The score is taken directly from the LRS. The TinCan Package must provide the score in the way described in the README.md file or on the !module_page to the LRS. Then, this module will get the score back from the LRS and register it to this Opigno LMS instance.', array(
        '!module_page' => l(t('module page'), 'https://www.drupal.org/sandbox/amermod/2705191'),
      )) . '</dd>';
      $output .= '<dt>' . t('TinCan Package specifications') . '</dt>';
      $output .= '<dd>' . t('The TinCan Package must follow, at least, the specifications written in the README.md file or on the !module_page. A good TinCan Package should follow the specifications written on the official !github_page.', array(
        '!module_page' => l(t('module page'), 'https://www.drupal.org/sandbox/amermod/2705191'),
        '!github_page' => l(t('Github page'), 'https://github.com/RusticiSoftware/launch/blob/master/lms_lrs.md'),
      )) . '</dd>';
      $output .= '</dl>';
      return $output;
  }
}