Skip to content

Commit

Permalink
discription for similarity check,PDF download and openAI response
Browse files Browse the repository at this point in the history
  • Loading branch information
Elahe-Aliez committed May 2, 2023
1 parent 948031d commit f4ee38a
Showing 1 changed file with 40 additions and 40 deletions.
80 changes: 40 additions & 40 deletions docs/Elements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -535,44 +535,7 @@ allow retake

.. note:: Informed Consent: Participants are asked by the browser if the browser can access the webcam or not. Please make participants aware that they do not have to take a picture and ask them for their consent.

Retrieving Pictures
-------------------
Pictures can be retrieved in the following ways:

At the participant' screen
You can use the normal variable notation ($image;) to display pictures in text boxes.

At the lecturer screen
You can use :php:`$getValues(...)` to retrieve the pictures of all participants and display them (see :ref:`Programming:Functions`).

From the stored data
In the downloaded data you find stored images in the subjects table. They are base64 decoded and can be encoded with free online tools. Just take away "data:image/jpeg;base64," from the string, so that it starts e.g. with "/9j/....".

Javascript program
~~~~~~~~~~~~~~~~~~~

You can also add small javascript programs to the participant screen. More information can be found at :ref:`Programming:Javascript`.

Filled in form
~~~~~~~~~~~~~~

This element allows you to display the filled in input element of the previous stage. This element is outdated and should only be used with care.

Elements for lecturers
======================

Start button and automatic start
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The start button is used to initiate a stage.

.. important:: Each stage requires a start button or an automatic start. If stages have result elements, this is not true as result elements automatically provide a button to start the stage (if no other button is defined).

There are two alternatives. A start button which has to be clicked by the experimenter or an automatic start.



similarity Check(beta)
similarity check(beta)
~~~~~~~~~~~~~~~~~~~

In similarity check, the main part consists of one input field and a textbox. You can define a variable in the stage before, and then use that variable name in input field (this stage) for comparing the correct solution with the answer.
Expand All @@ -596,7 +559,7 @@ Some of the points obtained from the comparison of each pair of sentences(one se


PDF download
------------
~~~~~~~~~~~~~~~~~~~

In PDF download, the main part consists of one text field(textbox). You can add your desired text includes questions, answers,.... in the textbox.

Expand All @@ -605,14 +568,51 @@ this feature will appear as an input button at the end of a game, and students c


openAI response
------------
~~~~~~~~~~~~~~~~~~~

In openAI response feature, the main part consists of one text field(textbox). You can add your desired prompt,questions, sample solution,.... in the textbox in this stage. Then use the variable name (the one that you defined in one stage before) to send the student's answer and your prompt to openAI server. As a Response the AI will send you a feedback on student's answer depends on your given Prompt. At the end it will show the feedback to the participants.





Retrieving Pictures
-------------------
Pictures can be retrieved in the following ways:

At the participant' screen
You can use the normal variable notation ($image;) to display pictures in text boxes.

At the lecturer screen
You can use :php:`$getValues(...)` to retrieve the pictures of all participants and display them (see :ref:`Programming:Functions`).

From the stored data
In the downloaded data you find stored images in the subjects table. They are base64 decoded and can be encoded with free online tools. Just take away "data:image/jpeg;base64," from the string, so that it starts e.g. with "/9j/....".

Javascript program
~~~~~~~~~~~~~~~~~~~

You can also add small javascript programs to the participant screen. More information can be found at :ref:`Programming:Javascript`.

Filled in form
~~~~~~~~~~~~~~

This element allows you to display the filled in input element of the previous stage. This element is outdated and should only be used with care.

Elements for lecturers
======================

Start button and automatic start
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The start button is used to initiate a stage.

.. important:: Each stage requires a start button or an automatic start. If stages have result elements, this is not true as result elements automatically provide a button to start the stage (if no other button is defined).

There are two alternatives. A start button which has to be clicked by the experimenter or an automatic start.





Start button
Expand Down

0 comments on commit f4ee38a

Please sign in to comment.