What are the Players used for?

The Player in tt knowledge force shows the e-learning to the user in a browser.
It controls the loading of the e-learning document and displays the latter's individual pages.
There are two differen player types which are used in the following cases:




HTML Player

• WYSIWYG editor


• WYSIWYG view in the Editor


• Preview view started from the Editor


• Export for documents the player type set to 'HTML'.

• Export for documents with the player type set to 'HTML5'.

The HTML Player

API support: SmartComponents Standard Player API


Its functional scope also comprises the tutorial control. The tutorial control has the following functions:

• going from one page to the next (or previous) one


• skip to another chapter (when in the study mode)


• repeat animations incl. sound of a page


• pause / resume animations incl. sound on a page


• enable / disable the sound of the e-learning


• assess a test question, display the assessment, show the sample answer (study mode)


• Test question: Proceed


• Test question: Assess and exit (assessment mode)


• Change the play mode of an e-learning in study mode: Interactive mode, film mode, presentation mode


• Exit the e-learning

The ttkf Player determines the current learning progress and passes it on to the Browser or a Learning Management System after the document is closed.
To handle functions and data in the scope of the wbt lifecycle, the player also provides a stage for the e-learning:

• StageContext


• StageVariableContext


• StageEventContext

The HTML5 Player

API support: SmartComponents HTML5 Player API


With version 2015 (11.0) ttkf provides a new HTML5 export. This content is highly optimized for modern and mobile browsers.
Due to the focus on the performance, we have developed a new player, based on the latest html5 web technology.

What's an e-learning page?

An e-learning page contains the
content in a fixed size, like a PowerPoint slide. A page can be subdivided into
information related to the page itself, and page content. The page content area
may contain objects, animations, sounds, and effective. It may also allow users
to perform interactions. Switching to the next page is done using an
interaction (in the content area, or via the tutorial control). The Player will
then proceed and display the next page.

What page types are there?

Pages with content

• Content page: Displays the content that is to be trained.


• Simulation page: Displays IT simulations.


• Evaluation page: Displays the total result of all visited test question pages at a glance

Test question page

Poses a challenge to the user as part of a quiz
Information on pages can be queried via the Player API. Please see:

• Page in the e-learning
  
  
  
  • Page
  
  
  • PageContext
  
  
  • PageDragAndDropContext
  
  
  • PageEventContext
  
  
  • PageGroupContext
  
  
  • PageGroupEventContext
  
  
  
  


• Quiz in the E-Learning
  
  
  
  • PageQuizContext
  
  
  • PageQuizEventContext
  
  
  • QuizContext
  
  
  • QuestionContext
  
  
  • AnswerContext
  
  
  
  

How is an e-learning structured?

The pages in an e-learning are always arranged as a path. Each TT document starts with the first page of the main path,
and ends with its last. It is possible to branch to a parallel path from any page in the main path.
All parallel paths eventually lead back to the main path. Parallel paths may be named to improve navigation in the site map.

Information on the main path, as well as on parallel paths, can be queried via the Player API
(please see: LearningPaths, Stage).

What are the general modes for playing back an e-learning?

Study mode

In the study mode, there is no difference between content pages and question pages. The learning progress tracks how far
a learner has progressed on the main path. The learning progress is passed on as a score once the e-learning is closed.
Parallel paths have their own separate learning progress.

In study mode, question pages are provided to the learner as a means for self-monitoring. Each question is immediately
assessed and the result is displayed. The learner may choose to view the sample answer.

The edit state can be calculated based on the page structure of the main path (or parallel path, respectively) please
see LearningPath). The current mode of the TT document can be queried via the Player API.
(Please see: StageContext)

Assessment mode

In the assessment mode, content and question pages are treated separately. The edit state is calculated from the
individual scores of the visited test question pages. It is passed on as a score once the assessment is closed.




Test question pages


You can use SmartComponents to create quiz elements and to tell the player whether an answer was correct or not.
See the Demo SmartComponent: SC/MC element, D&D source and D&D target, cloze test. (in progress)
Creating quiz elements is done via:

• PageQuizContext


• PageQuizEventContext


• QuizContext


• QuestionContext


• AnswerContext

Evaluation page


On the evaluation page, both the total result and all individual page results can be displayed.
See the Demo SmartComponent: Evaluation single result and Evaluation all results (in progress)

The document-wide score calculation cannot be influenced via the Player API, as the score calculation is performed by
the player. It's also not possible to set the score. The score can only be queried (read). TTplayer performs the
SCORM-related communication with third-party systems like Learning Management Systems (LMS).

The current mode of the TT document can be queried via the Player API.
Please see isInLearningMode() and isInAssessmentMode() in the StageContext




Note


There are three different methods in the player for determining the result achieved on a question page.
The actual method is set via customizing and thus cannot be altered by the API. For more information on these settings,
please contact your AWB / professional services consultant.

What states are possible for a question page?

• Test state
  
  
  The learner can answer the question page (Study mode and Assessment mode)


• Evaluation state
  
  
  The answers have been assessed and the correct as well as the wrong ones are highlighted (Study mode and possibly in the assessment mode, depending on the ttkf configuration)
  


• Sample-answer state
  
  
  The correct answer is displayed (Study mode)
  

What are parameters?

Parameters are used to

• pass information via the UI API to tt knowledge force.
  
  
  (via the parameters specified in com.tts)
  


• pass values to the SmartComponent's class.
  
  
  (Custom parameters)
  

A text parameter that has been set via the Custom-parameters can be used to allow an author to enter text in the
properties dialog which can then be displayed in the e-learning via the SmartComponent. For the text field in the
properties dialog, default values can be specified in the metadata.js on a per-language basis (i18n localized strings;
depending on the e-learning's language). Those pre-defined texts can be changed by the e-learning author, with the
updated text passed on to the SmartComponent. In addition, those texts as a whole are subject to the translation
workflow of ttkf. So, if you create a language variant of an existing document at a later point in time and perform a
translation export, the text parameters specified in the Customer parameters are included in the exported file.
Once translated, the text for the target language are imported and automatically transferred to the SmartComponent.

Note:

• A SmartComponent's title and category cannot be combined with the procedure outlined above.
  (For language-dependent category and title, please see the following chapter: Defining a SmartComponent and
  UI elements)
  


• A SmartComponent's description (name field) cannot be combined with the procedure outlined above.
  (a language-dependent default text for the description is not possible at present).
  


• Texts that are only displayed in the SmartComponent, without providing a way for the author to change them,
  are defined in the class. Via the Stage context and the Stage.getContentLanguage() function, the e-learning's
  language can be determined, which allows the text to be displayed in the correct language.
  This procedure is used to design multi-lingual SmartComponents which can be used in document variants that are
  in another language. The texts pre-defined in a SmartComponent are then automatically displayed in the matching
  language.
  

How to use events?

####player events

The Player of the tt knowledge force sends events itself. These events are:

• PageEventContext
  
  
  
  • OnEnter (makes sure the component reacts to "onEnterPage" and "onAllComponentsReady")
  
  
  • OnExit
  
  
  
  


• PageQuizEventContext
  
  
  
  • OnEvaluateTestRun
  
  
  • OnUserSolution
  
  
  • OnBestPracticeSolution
  
  
  
  

Custom events

The SmartComponents api provides sending and receiving functions for events in the different contexts:

• StageEventContext


• PageEventContext


• PageGroupEventContext


• PageQuizEventContext