Version 2.3.0

alxlion · alxlion · commit 78629c5e3002 · 2024-12-28T18:02:35.000-05:00
diff --git a/.vitepress/config.mts b/.vitepress/config.mts
@@ -54,6 +54,7 @@ export default defineConfig({
           { text: "Questions", link: "/usage/qa" },
           { text: "Forms", link: "/usage/forms" },
           { text: "Polls", link: "/usage/polls" },
+          { text: "Quizzes", link: "/usage/quizzes" },
           { text: "Web Content", link: "/usage/webcontent" },
           { text: "Reports", link: "/usage/reports" },
         ],
diff --git a/integration/lti.md b/integration/lti.md
@@ -1,8 +1,8 @@
 # LTI integration (Beta)
 
-You can integrate Claper with other tools using LTI: Moodle, Canvas...
+You can integrate Claper with other tools LMS using LTI. Currently, only **Moodle** has been tested and we recommand you to use it.
 
-Claper uses LTI 1.3 to connect with your LMS and allow your students to join events directly from your LMS.
+Claper uses LTI 1.3 to connect with your LMS and allow your students to join events directly from your it.
 
 :::info Only on self-hosted version
 This feature is available on the self-hosted version of Claper and is not yet available on the Cloud version.
@@ -18,15 +18,21 @@ To register Claper as an LTI tool in Moodle:
 4. Activate Claper
 5. Change settings (if not already done):
 
-   - **Default launch container:** New window
-   - **Tool configuration usage:** Show in activity chooser and as a preconfigured tool
+   - **Tool settings > Default launch container:** New window
+   - **Tool settings >Tool configuration usage:** Show in activity chooser and as a preconfigured tool
+   - **Services > IMS LTI Assignment and Grade Services:** Use this service for grade sync and column management (for quizzes)
 
 6. Choose Claper in the activity chooser.
 7. Set activity name, this will be the name of the created event.
 8. Once your activity is created, click on the Claper link to create the event (you need to be an instructor or admin).
 9. Every other instructor who click on the link will be added as a facilitator to manage the event.
 10. Students are redirected to the event view (if created) to start interacting.
 
+:::info HTTPS requirements for quizzes
+
+To use LTI with Assignment and Grade Services (AGS), you need an HTTPS endpoint for your LMS and for Claper.
+:::
+
 ## Canvas, Blackboard...
 
-These steps should be similar to the Moodle one, but if you have any trouble or want to contribute to the documentation for these LMS, please let us know.
+At this time, only Moodle has been tested with LTI integration. If you have any other LMS that works with LTI, please let us know and we will contribute to the documentation about it.
diff --git a/public/quiz.png b/public/quiz.png
diff --git a/public/usage/quiz/grade.png b/public/usage/quiz/grade.png
diff --git a/public/usage/quiz/manage.png b/public/usage/quiz/manage.png
diff --git a/self-hosting/configuration.md b/self-hosting/configuration.md
@@ -156,36 +156,6 @@ SMTP password
 
 SMTP port
 
-### SMTP_TLS
-
-**Default value**: `always`
-
-**Accepted values**: `always, never, if_available`
-
-**Required**: `No`
-
-SMTP TLS
-
-### SMTP_AUTH
-
-**Default value**: `always`
-
-**Accepted values**: `always, never, if_available`
-
-**Required**: `No`
-
-SMTP Auth
-
-### SMTP_SSL
-
-**Default value**: `true`
-
-**Accepted values**: `true, false`
-
-**Required**: `No`
-
-SMTP SSL
-
 ### ENABLE_MAILBOX_ROUTE
 
 **Default value**: `false`
diff --git a/usage/manager.md b/usage/manager.md
@@ -28,21 +28,23 @@ If you find a message interesting, you can pin it by clicking on **Pin**. This w
 
 ### Presentation settings
 
-Presentation settings allow you to control what is displayed on the screen. You can show the chat, poll results, or instructions to join the event.
+Presentation settings allow you to control what is displayed on the presentation. You can show the chat, poll results, or instructions to join the event.
 
-- **Show instructions**: Display instructions to join the event on the screen. This is useful if you have attendees who are not familiar with Claper. They can scan the QR code or enter the code to join the event.
-- **Show messages**: Display the chat messages on the screen.
-- **Show only pinned messages**: Display only the pinned messages on the screen.
-- **Show poll results**: Display the poll results on the screen, this will show in real-time the poll results of the active poll.
+- **Show instructions to join**: Display instructions to join the event on the presentation. This is useful if you have attendees who are not familiar with Claper. They can scan the QR code or enter the code to join the event.
+- **Show messages**: Display the chat messages on the presentation.
+- **Show only pinned messages**: Display only the pinned messages on the presentation.
 
 ### Attendees settings
 
 Attendees settings allow you to control the attendees' experience during the event, what they can do or see on their device.
 
 - **Enable messages**: Allow attendees to send messages in the chat.
 - **Enable anonymous messages**: Allow attendees to send messages anonymously. This is useful if you want to keep the chat open to everyone. If you disable this option, attendees will have to enter their name to send a message.
-- **Enable message reactions**: Allow attendees to react to messages by clicking on the reaction button. This will show a list of reactions that attendees can choose from.
-- **Show poll results**: Allow attendees to see the poll results on their device. This will show in real-time the poll results of the active poll. If you disable this option, attendees will not see the poll results.
+- **Enable reactions**: Allow attendees to react to messages by clicking on the reaction button. This will show a list of reactions that attendees can choose from.
+
+### Interaction settings
+
+Some interactions like polls and quizzes can have speicific settings, like showing results on the screen or not. Refer to the interaction documentation for more information.
 
 ## Add interactive elements
 
diff --git a/usage/quizzes.md b/usage/quizzes.md
@@ -0,0 +1,43 @@
+# Quizzes
+
+![Quiz Feature](/quiz.png)
+
+Quizzes are perfect for testing the knowledge of your audience. You can create quizzes during your presentation and see the results in real-time.
+
+## Create a quiz
+
+When you create a quiz, you can add up to 10 questions. Each question should have at least one correct answer.
+
+You can add as many answers as you want for each question.
+
+## Quiz results
+
+When **Show results on presentation** is enabled, attendees can see their results once they have submitted their answers. This also displays the average score of the quiz in your presentation.
+
+![Manage quiz](/usage/quiz/manage.png)
+
+:::warning
+Attendees cannot change their answers once they have submitted the quiz.
+:::
+
+## Questions review
+
+You can review the quiz answers by clicking the **Review questions** button in the [Event manager](/usage/manager.md). Use the next/previous buttons to navigate through the questions and review your audience's answers. This only affects your presentation view; attendees can independently navigate through the questions on their devices.
+
+## LTI Assignment and Grade Services (Moodle)
+
+:::info Only on self-hosted version
+This feature is available on the self-hosted version of Claper and is not yet available on the Cloud version.
+:::
+
+See [LTI integration](/integration/lti.md) for more information about LMS integration.
+
+Every quizzes you create will be available on your LTI tool in Moodle, as a column, if the event is linked to a resource. 
+
+If an attendee submit quiz answers, he will receive a grade in Moodle.
+
+### Enable grades
+
+When you create a resource on your LMS (Moodle for the example), be sure to enable grade of type _Points_ with maximum value of **100**. 
+
+![Grade in Moodle](/usage/quiz/grade.png)
diff --git a/usage/reports.md b/usage/reports.md
@@ -11,10 +11,21 @@ To access the report, you have to terminate your event. To do so, click on the *
 The report contains the following metrics:
 
 - **Audience peak**: The maximum number of attendees who were connected at the same time.
-- **Messages**: The total number of messages sent during the event.
-- **Average voters**: The average number of voters per poll.
+- **Unique attendees**: The number of unique attendees.
+- **Messages**: The total number of messages sent.
 - **Engagement rate**: The percentage of attendees who interacted during your event.
 
+### Engagement rate calculation
+
+The engagement rate is an important metric to understand the engagement of your audience. It is calculated using the following formula:
+
+- Messages (m): **All distinct messages sent** / **Number of unique attendees**.
+- Polls (p): **All the polls submitted** / (**Number of polls** x **Number of unique attendees**).
+- Forms (f): **All the forms submitted** / (**Number of forms** x **Number of unique attendees**).
+- Quizzes (q): **All the quizzes submitted** / (**Number of quizzes** x **Number of unique attendees**).
+
+**Engagement rate = (m + p + f + q) / 4**
+
 ## History
 
 In the report, you will see all the interactions that were made during the event. You can see the messages, the polls and the forms that were sent all along the presentation.
