Downloading and Installation

Follow these steps to install the QuizDeck LMS - Quiz Addon for the Lernen in your Lernen project:

• Step 1: Download the Package

  When downloading the zip package file from CodeCanyon, you'll have all the files you need inside. The zip package contains the following files:

  • Quiz.zip contains the QuizDeck LMS - Quiz Addon for the Lernen
  • documentation.zip folder (It contains documentation for the add-on)

• Step 2: Extract the Package
  • Extract the downloaded zip file i.e. Quiz.zip
• Step 3: Install Quiz Addon
  • Goto Admin > Manage Addons > Add new and click on Add/Update addon.
  • Choose the Quiz.zip file and click on Install.
• Alternatively, Manually Installation

  If you prefer to manually install the QuizDeck LMS add-on, follow these steps:

  • Extract the downloaded zip file i.e. Quiz.zip
  • After uploading you need to execute the following commands in the website root directory through CLI
    • Execute this – php artisan module:enable Quiz
    • Execute this – php artisan module:migrate Quiz
    • Execute this – php artisan module:publish Quiz
    • Execute this – php artisan module:seeder Quiz

Quiz Settings

The Site Management > Global Settings > Quiz Settings section in the Lernen platform allows administrators to configure various aspects of quiz generation and customization. These settings help automate quiz creation using AI while providing flexibility in structuring different question types and tutors.

• Generate Quiz with AI: Toggle this option to allow AI to create quizzes with ease of AI.
• Generate quiz AI prompt: Predefined JSON structure for AI to generate quiz questions based on input parameters such as subject, course type, and question categories.
• Max number of Mcq's questions AI can create: Limit the number of MCQs per quiz. If you choose larger number it will take time to generate so much questions and you may face request timeout error.
• Max number of True/False questions can create: Define how many True/False questions AI can generate. If you choose larger number it will take time to generate so much questions and you may face request timeout error.
• Max number of Fill in blanks questions can create: Specify the number of fill-in-the-blank questions. If you choose larger number it will take time to generate so much questions and you may face request timeout error.
• Max number of Short questions can create: Control the maximum number of short-response questions. If you choose larger number it will take time to generate so much questions and you may face request timeout error.
• Max number of Open Ended questions can create: Set limits for long-form descriptive answers. If you choose larger number it will take time to generate so much questions and you may face request timeout error.
• Quiz Start Banner Image: This option allows administrators to upload a banner image that appears at the beginning of the quiz. The image helps enhance the quiz interface and can include branding or relevant visuals.
• Quiz Start Heading: A text field where administrators can add a heading that appears at the start of the quiz. This heading can be a welcome message, quiz title, or an important instruction.
• Quiz Instructions: This section allows administrators to enter multiple quiz instructions for students. Each instruction is added in a separate text field. Users can add more instructions using the Add more button. Instructions can be removed using the red trash bin icon next to each instruction.
• Click on Save Changes to save the changes made to the quiz settings.

How to Create a Quiz

The Create Quiz feature allows tutors to build quizzes efficiently within the Lernen platform. Tutors can either manually create quizzes or use AI for automatic quiz generation. If AI is enabled, the Create a New Quiz popup will open; otherwise, the quiz will be created manually.

• After login click on Quizzes from the sidebar to access the My Quizzes page.
• On the My Quizzes page, locate and click the Create Quiz + button.
• A pop-up window will appear, offering two quiz creation options:
  Create Manually – Build the quiz from scratch.
  Generate with AI –Use AI to generate quiz questions quickly.

• If you select Create Manually, you will be redirected to a form where you can add questions, answers, and quiz settings.
• If you choose Generate with AI, the system will create a quiz based on predefined AI settings and input criteria.

Create Quiz Manually

After selecting Create Manually, a Quiz Details popup form appears. This form allows tutor to define key information about the quiz before adding questions.

• Quiz For:A dropdown menu to specify whether the quiz is for a Course or another Subject category. Ensures the quiz is correctly linked to relevant learning materials.
• Select Option: After selecting a course, an additional dropdown menu appears to choose the specific course title. This step ensures that the quiz aligns with the correct learning module
• Quiz Title: A text field to input the quiz title. The title should be clear and relevant to the course or topic.
• Quiz Description: A rich-text editor for adding a brief description or instructions for the quiz.
• Click Cancel to closes the popup without saving changes.
• Click Save to confirms the quiz details and proceeds to the quiz creation page, where questions can be added.

Important Note:

If the Course addons are enabled, the Quiz For dropdown will be shown; otherwise, it will not be displayed.

If the Course addons are not enabled, the Quiz For dropdown will not be shown.

Create Quiz with AI

When selecting Generate with AI, the system uses artificial intelligence to create quiz questions automatically based on tutor inputs. This feature streamlines quiz creation, saving time and ensuring variety in question types.

• Quiz For: Select whether the quiz is for a Subject or Course.
• Select Option: Choose the specific subject or course related to the quiz.
• Select Session: If select the subject when selecting the one or multiple sessions for which this quiz is applicable.
• Let AI Know the Brief of Quiz: Provide a short description or topic summary to help AI generate relevant questions.
• Question Type Selection: Tutors can specify how many of each question type AI should generate: True/False, Multiple Choice, Open-Ended Essay, Fill in the Blanks and Short Answer. The tutor can adjust the number for each type to create a balanced quiz.
• Click Cancel to discards the quiz setup and returns to the quiz list.
• Click Generate with AI to processes the input and generates the quiz based on the provided instructions.

Quiz Settings

After creating a quiz, the Quiz Settings tab allows tutors to configure essential and advanced settings to optimize the quiz experience. These settings control aspects such as quiz duration, grading, question order, and visibility options.

Basic Settings

• Set Quiz Duration: Allows tutors to set the time limit for the quiz (e.g., 2 minutes 30 seconds).
• Passing Grade: Defines the minimum percentage required to pass the quiz.
• Hide Quiz Timer: A toggle switch that, when enabled, hides the countdown timer from students during the quiz.

Advanced Settings

• Question Order: Controls the order in which questions appear. Options include Ascending (default), Descending, Random.
• Character Limit: Set Character Limit for Short Answers and Max Characters for Essays. Ensures responses fit within defined length constraints.
• Auto Result Generate: If enabled, the system automatically evaluates quiz responses (not applicable for short-answer and essay questions).
• Hide Question Numbers: A toggle switch that, when enabled, removes question numbering for a cleaner interface.
• Click Cancel to discards any changes made to the quiz settings.
• Click Save & Update to saves and applies all modifications to the quiz settings.

Question Manager

The Question Manager section is where tutors can add, edit, and organize quiz questions. After configuring the Quiz Settings, tutors can navigate to the Question Manager tab to define the content of the quiz.

• When a tutor clicks the Add Question button in the Question Manager, a popup appears, allowing them to select the type of question they want to add to the quiz.
• Short Answer: Allows students to answer questions with short text responses.
• Fill in the Blank: Provide a blank space for students to fill in the correct answer.
• Open-Ended Essay: Requires students to write detailed responses for longer questions.
• Multiple Choice: Present multiple choices for students to select from.
• True/False: Present a true/false question for students to answer.

Short Answer

After selecting the Short Answer question type, the system opens a detailed form where tutors can define the question, add additional details, and configure settings.

• Question Title: This is where the main question is entered.
• Question Description: This is where the description or instructions for the short answer question are entered.
• Media Upload: Tutors can attach image files to enhance the question. Supported formats include jpg, png, etc., with file size limits. The image extensions set by the admin will be displayed here.
• Question Settings: Tutors can customize how this question behaves in the quiz:
  • Points for Correct Answer – Set how many points this question is worth (default: 1 point).
  • Answer Required – If enabled, students must answer this question before moving forward.
  • Display Points – If enabled, students will see the point value assigned to this question.
• Click Back returns to the question list or previous page.
• Click Save to Saves the question and adds it to the quiz.

Fill in the Blank

After selecting the Fill in the Blank question type, the system opens a detailed form where tutors can define the question, add additional details, and configure settings.

• Question Title: The main question is entered here with placeholders {option} to indicate missing words.
• Media Upload: Tutors can attach image files to enhance the question. Supported formats include jpg, png, etc., with file size limits. The image extensions set by the admin will be displayed here.
• Answer : Tutors must define the correct answer for the blank space.
• + Add Blank Space : Tutors can insert multiple blank spaces within the question. Each blank space must have at least one correct answer.
• Question Settings: Tutors can customize how this question behaves in the quiz:
  • Points for Correct Answer – Set how many points this question is worth (default: 1 point).
  • Answer Required – If enabled, students must answer this question before moving forward.
  • Display Points – If enabled, students will see the point value assigned to this question.
• Click Back returns to the question list or previous page.
• Click Save to Saves the question and adds it to the quiz.

Open-Ended Essay

After selecting the Open-Ended Essay question type, the system opens a detailed form where tutors can define the question, add additional details, and configure settings.

• Question Title: This field contains the main prompt or question that students must answer.
• Question Description: A rich-text editor where tutors can provide additional details, guidelines, or background information related to the essay prompt.
• Media Upload: Tutors can attach image files to enhance the question. Supported formats include jpg, png, etc., with file size limits. The image extensions set by the admin will be displayed here.
• Question Settings: Tutors can customize how this question behaves in the quiz:
  • Points for Correct Answer – Set how many points this question is worth (default: 1 point).
  • Answer Required – If enabled, students must answer this question before moving forward.
  • Display Points – If enabled, students will see the point value assigned to this question.
• Click Back returns to the question list or previous page.
• Click Save to Saves the question and adds it to the quiz.

Multiple Choice

After selecting the Multiple Choice question type, the system opens a detailed form where tutors can define the question, add additional details, and configure settings.

• Question Title: The main question is entered in this field.
• Question Description: A rich-text editor is available to provide instructions or additional context for the question.
• Media Upload: Tutors can attach image files to enhance the question. Supported formats include jpg, png, etc., with file size limits. The image extensions set by the admin will be displayed here.
• Answer : Tutors can provide multiple answer options. The correct answer must be selected by clicking the green checkmark next to it. The + Add More button allows tutors to include additional answer choices.
• Question Settings: Tutors can customize how this question behaves in the quiz:
  • Points for Correct Answer – Set how many points this question is worth (default: 1 point).
  • Answer Required – If enabled, students must answer this question before moving forward.
  • Display Points – If enabled, students will see the point value assigned to this question.
• Click Back returns to the question list or previous page.
• Click Save to Saves the question and adds it to the quiz.

True/False

After selecting the True/False question type, the system opens a detailed form where tutors can define the question, add additional details, and configure settings.

• Question Title: This field contains the statement that students need to evaluate as True or False.
• Media Upload: Tutors can attach image files to enhance the question. Supported formats include jpg, png, etc., with file size limits. The image extensions set by the admin will be displayed here.
• Answer : Students must choose between two predefined options: True or False. The correct answer is selected by clicking the green checkmark next to the correct option.
• Question Settings: tutors can customize how this question behaves in the quiz:
  • Points for Correct Answer – Set how many points this question is worth (default: 1 point).
  • Answer Required – If enabled, students must answer this question before moving forward.
  • Display Points – If enabled, students will see the point value assigned to this question.
• Click Back returns to the question list or previous page.
• Click Save to Saves the question and adds it to the quiz.

Publishing the Quiz

Once all the questions have been added and the quiz is finalized, tutors can publish the quiz to make it available for students.

• When the Publish button is clicked in the Question Manager, a confirmation popup appears
• Click Cancel to stops the publishing process, allowing further edits to the quiz.
• Click Save to confirms the action and makes the quiz available to students.

Important Note:

Once the quiz is published, editing will no longer be possible.

Manage Quizzes

The Manage Quizzes page allows instructors to track student progress and manage quizzes efficiently.

• Clicking the three-dot menu (⋮) next to a quiz opens the management options. View Attempts, Duplicate Quiz amd Archive Quiz.
• View Attempts Allows instructors to track student submissions and performance. If the quiz is published, View Attempts will be shown in the dropdown; otherwise, it will not be displayed.
• Duplicate Quiz Creates a copy of an existing quiz, which can be modified and reused.
• Archive Quiz Moves the quiz to the Archived tab, hiding it from the active list.
• Tutors can filter quizzes based on their status. All , Draft , Published , and Archived.
• All Displays all quizzes.
• Draft Shows quizzes that are not yet published.
• Published Displays live quizzes available to students.
• Archived Contains quizzes that have been manually archived.
• Click Cancel to stops the publishing process, allowing further edits to the quiz.
• Click Save to confirms the action and makes the quiz available to students.

Quiz Attempts

If auto result is enabled, the student's result will be instantly generated upon completion and displayed to student.

Review Quiz

If auto result is disabled, the student's attempt will be sent for review after submission. The tutor will assess it and manually generate the result.

Attach Certificate

Session base certificate assignment

In the Add Session Details form, tutors can define how certificates are granted to students. The following fields are available:

• Certificate Template: Tutors can select a pre-designed certificate template for students who meet the completion criteria.
• Assign Certificate Condition: This dropdown allows tutors to define the conditions under which a certificate will be awarded.
• Available conditions include:
  • Passing at least one quiz– Students receive a certificate if they pass at least one quiz in the session.
  • Passing all quizzes – Certificates are awarded only if students pass all quizzes assigned in the session.
  • Without passing any quiz – Students receive a certificate regardless of quiz performance (completion-based certification).
• If the UpCertify Addon is enabled, the Certificate Template: and Assign Certificate Condition: fields will be visible in the session creation form.
• If the UpCertify Addon is not enabled, these fields will not appear, and tutors will not have the option to assign certificates.

Course base certificate assignment

In the Basic Details step of course creation, tutors can define how certificates are awarded to students upon course completion.

• Certificate Template: Tutors can select a predefined certificate template that will be issued to students who meet the completion criteria.
• Assign Certificate Condition: Tutors can specify conditions under which students will receive a certificate.
• Available conditions include:
  • Passing at least one quiz– Students receive a certificate if they pass at least one quiz in the session.
  • Passing all quizzes – Certificates are awarded only if students pass all quizzes assigned in the session.
  • Without passing any quiz – Students receive a certificate regardless of quiz performance (completion-based certification).
• If the UpCertify Addon is enabled, the Certificate Template: and Assign Certificate Condition: fields will be visible in the session creation form.
• If the UpCertify Addon is not enabled, these fields will not appear, and tutors will not have the option to assign certificates.

Quizzes

The Quizzes page provides provides students with an organized interface to view and attempt assigned quizzes. It categorizes quizzes into Upcoming and Attempted quizzes, allowing students to track their assessments. Students cannot manage quizzes; they can only view assigned quizzes, attempt them, and view the results of their attempted quizzes.

• Click on Quiz Title to start the attempt of the quiz. Follow the provided instructions and complete the quiz within the given duration.
• Upcoming Filters: Displays quizzes that students need to complete.
• Attempted Filters: Shows quizzes that have already been taken by the student.
• Search by Keyword: Allows students to quickly find a specific quiz.

How a Quiz Assigned to Student

Session base quiz assignment

When a student completes a Session, the Quizzes for that session will be automatically assigned to them. Additionally, an email and notification will be triggered for the assigned quiz.

Course base quiz assignment

When a student completes a Course, any Quizzes associated with that course will be automatically assigned to them. Additionally, an email and notification for the assigned quiz will be triggered.

How to Attempt a Quiz

After clicking on a quiz title from the Quizzes List, students are redirected to the Quiz Attempt Start Page. This page serves as an introduction before students begin the quiz.

After clicking the Start Quiz button on the Quiz Attempt Start Page, a confirmation popup appears. This serves as a final prompt before officially beginning the quiz.

After clicking the Start Quiz button, students are redirected where they answer questions within the allotted time. This page provides an interactive and structured assessment experience.

Quiz Result

The Quiz Result page, which displays their performance summary. If the student meets the passing criteria, a "Congratulations You Passed!" message is shown.

The Quiz Result page, which displays their performance summary. If the student does not meet the passing criteria, a "Don't Give Up! Keep Learning!" message is displayed, encouraging them to try again.

Important Note:

If auto-generated results are enabled, the pass/fail screen will appear; otherwise, the In Review screen will be displayed.