Authoring Tool

2020-10-21

1 Authoring Tool

1.1 Introduction

The Authoring Tool is part of the orthoeman Moodle plugin and it designed so course creators (authors, teachers) can annotate media and create quizzes based on them.

This document assumes that you have reached the point of creation of an activity of type orthoeman.

1.2 Entering Authoring Tool

The second time you visit the case configuration page you encounter a page similar to the picture but with one important difference. In the main area, at the start of the page, there is a link.

Link to Authoring Tool

By clicking the link Authoring Tool will start in a frame inside moodle. If screen estate proves to be scarce we may consider of having a way starting Authoring Tool in a new page. Note also, that the way of Authoring Tool invocation may change in general e.g. the link may become a button in the middle of the page etc.

1.3 First Contact

The Authoring Tool is a web based application that helps the author to create or edit an orthoeman compatible case. In the figure below you can see the opening screen for the program.

Authoring Tool

The main screen of the program is divided into the following areas:

Main areas of Authoring Tool
1 Upper Toolbar
2 Pages Container
3 Page Area
4 Media Container
5 Non Media Container (Text, Quiz, RangeQuiz)

1.4 Upper Toolbar

The toolbar hosts 4 visible buttons. From left to right the buttons are:

Bug Report Tool

1.5 Page Container

The page container contains the pages (slides) the author creates. There are 4 buttons in two button areas.

Page Container

The pages are identified by their title. Note that the Display Tool may not display the page title. Nevertheless a concise page title is strongly advised to be entered in order to help author organize the case and keep the overall overview. Note that the page title inside the slide will be updated when the Page Title textbox looses its input focus.

1.6 Page Area

The page area is depicted below.

Page Area

The page area has the following elements

1.7 Media Container

The media container is the place where the image or the video is displayed. There is an upload button that initiates the upload procedure. In the case of image only PNG and JPEG image formats are allowed. In case of video the following video types are allowed (MPEG, MOV, AVI,and MP4). Note that AVI is not a video format itself, but a container format meaning it may include different video and audio encoding formats such as divx, xvid, theora, etc... In order for the video to be visible in modern HTML5 browsers it has to be trans-coded to mp4 and to webm formats. This operation may take several minutes and it is being done during video upload. For a 10 second video a 90 second upload and trans-coding time may be required depending on the server load. Also the operation may fail if the original video format is not understandable by the ffmpeg which is used on the server to perform the trans-coding. In such a case you will have to resubmit the video using an alternative format.

1.8 Non Media Container

The Non Media Container contains the following widgets

1.9 Case structure

A lesson consists of a collection of pages. Currently there are no limits in the number of pages a lesson can have. Each page has a a title and two items that should be edited and populated with the author's content. The left panel of the application is responsible for the management of the pages. There are buttons for adding and removing pages and buttons for page reordering. The content item can be of the following type:

However not all item type combinations are valid. A page can only have one the following item type combinations.

A page is characterized by its title and by its type (the combination of item types)

1.9.1 Image – Text

The Image – Text page type used for two types of pages:

Image - Text: Hotspot

The hotspots are drawn with a orange pen while the informational areas are drawn with blue pen. (consult the color map table below for reference). The choice where a drawing will be hotspot or informational is selected with the combobox in the middle of the tools as it is shown above. The difference is that hotspots are expected to be found by the students during the exam while the informational areas are shown to exemplify aspects of the theory.

Color Map Table
Hotspot Orange
Informational Blue
Helper Yellow
Eraser Red
Other uses Black

The image container sports several tools in order to help the author properly annotate the image.

Image Toolbar

From left to right:

1.9.2 Image – Quiz

In the image below the Image – Quiz combination is depicted. When the quiz is selected the hotspot functionality is disabled. Existing hotspots are converted to informational drawings. The quiz widget is shown in the right side of the Authoring Tool. The quiz supports arbitrary number of possible questions and arbitrary number of correct questions. The widget supports addition and removal of questions but not reordering of the questions.

Image Quiz

1.9.3 Image – Range Quiz

The Image – Range Quiz page type asks from the student to submit a value. The authoring teacher specifies in the right side panel the range of acceptable answers. Before entering the range the teacher should also type in a descriptive question just above the range. Make sure that units are properly specified in the question and in the entered region since the student can only type raw numbers.

Image Range-Quiz

1.9.4 Video – Text

The Video – Text page type can be used only for theory and not for student's evaluation. The authoring teacher provides a video (be patient during upload and trans-coding) and a text description highlighting the relevant points.

1.9.5 Video – Quiz

The Video – Quiz page type is like the Image – Quiz where the authoring teacher specifies a multiple choice for the student to answer.

1.9.6 Text – Quiz

The Text – Quiz page type is a classic non multimedia quiz where the student can be examined in theory.