Hello, I am Wiego. Please start by reading the whole documentation! If you have any questions, find a bug or experience difficulties getting the plugin to work please use the Support Forum. Only leave a Review if you are happy with the plugin or are still unhappy with the plugin after reaching out to me in the Support Forum. Thank you!

Table of contents

• Installation
• Getting started
• Available permissions
• Available languages
• Adding courses
• Adding lessons to a course
• Adding assignments to a course
• Adding tests to a course
• Adding students
• Adding answersheets
• Approving submitted student assignments
• Grading submitted student tests
• Granting students permissions
• Email notifications
• Courses component
• Course component
• Lesson component
• Assignment component
• Test component
• Grades component
• Courses widget
• Assignments widget
• Tests widget
• Overview widget
• Activity widget
• Programmatically adding permissions and enrolling students
• Overwrite partials
• Extend backend views
• Available events
• Adding form fields
• Adding columns to lists
• Support

Installation

You need an account on octobercms.com to install this plugin.

1. Sign in and click on the Add to Project button on the product page for the plugin in the marketplace.
2. Select the project you wish to add the plugin to (or create one).
3. Make sure you install any 3rd-party plugins this plugin depends on
4. Make sure you have attached this project to your website in the backend of your website in order to pull in the new plugin (Settings > Updates & Plugins). Don't worry, attaching or detaching your website to a project will never delete anything!

Getting started

Please note that RainLab.User is required for this plugin. This plugin supports RainLab.Translate for translating backend form fields and optionally translating views. These plugins are both FREE.

1. Add Briddle.Lms to a project and attach it to your website (This plugin requires RainLab.User so add this first).This plugin is FREE.
2. Go to Settings > Lms > Settings to configure the plugin
3. Go to the LMS in the backend to add permissions for students and add your courses, lessons, assignments, tests and students.
4. Add the components to your pages

Please note that for scheduled tasks to operate correctly, you should add a Cron entry to your server (see October CMS docs)

Example for the pages in the LMS:

• /lms
• /lms/course/:slug
• /lms/lesson/:slug
• /lms/assignment/:slug
• /lms/test/:slug

Available permissions

As always you can set backend permissions for this plugin in Settings > Administrators > LMS

• Manage students briddle.lms.student
• Manage courses briddle.lms.course
• Manage lessons briddle.lms.lesson
• Manage assignments briddle.lms.assignment
• Manage tests briddle.lms.test
• Manage submitted assignments briddle.lms.studentassignment
• Manage submitted tests briddle.lms.studenttest
• Manage assigned permissions briddle.lms.studentpermission
• Manage permissions briddle.lms.permission
• Manage settings briddle.lms.settings
• Manage answersheets briddle.lms.answersheet

The plugin also supports front-end permissions to allow drip-feeding your course content by permission (LMS > Answersheets). Note that permissions are only implemented in the views of components so you can decide how to use them in your own partials.

The visibility of courses and content depends on:

1. Is the user logged in?
2. Is the user signed up for this course?
3. Is the assignment or test already submitted (show the result if it is)?
4. Is the date within the range specified for the course and the lesson, assignment or test?
5. Does the student have permission to see the course and the lesson, assignment or test? In contrast to the other checks, students who do not have permission to view a course, lesson, assignment or test will still be able to see it, but it is locked and any content is omitted.

Rather than assigning permissions to users in the backend manually, you will probably want to extend this plugin with your own plugin to automate this based on your own criteria (e.g. a student assignment is passed, a test is rated, etc.). If you have setup answersheets, permissions will be granted after students submit their answers.

Available languages

You can use the free RainLab.Translate plugin to translate views and content.

This plugin can be translated in any language but supports the following languages out of the box:

• english
• dutch
• german
• french
• russian
• chinese

Adding courses

You can add courses by navigating to LMS > Courses in the backend of your October installation.

Adding lessons to a course

You can add lessons to a course by navigating to LMS > Courses in the backend of your October installation and opening the tab called Lessons.

Adding assignments to a course

You can add assignments to a course by navigating to LMS > Courses in the backend of your October installation and opening the tab called Assignments.

Adding tests to a course

You can add tests to a course by navigating to LMS > Courses in the backend of your October installation and opening the tab called Tests.

Adding students

You can add students to a course by navigating to LMS > Courses in the backend of your October installation and opening the tab called Students.

Adding answersheets

You can add answersheets for tests by navigating to LMS > Answersheets in the backend of your October installation.

In contrast to other software, Synapse does not split tests up into separate questions. This has advantages and disadvantages.

Advantages:

• In Synapse, the form inputs that students use to answer the questions in a test are generated from HTML headings and lists. This makes it easy to write and change tests.

Disadvantages:

• In Synapse you cannot assign different points to different answers
• More advanced question types like matching are not supported

You can use the WYSIWYG editor to write the following HTML:

<h2>What is a primary color?</h2>
<p>You have learned about primary colors in lesson 1.</p>
<ol>
  <li>Purple</li>
  <li>Red</li>
  <li>Green</li>
</ol>
<h2>What is a secondary color?</h2>
<p>You have learned about secondary colors in lesson 2. You can select multiple answers.</p>
<ul>
  <li>Purple</li>
  <li>Red</li>
  <li>Green</li>
</ul>

The list of options will be converted into radio inputs. When submitted, it will produce:

1: Red
2: Purple

This allows you to add inline comments to the submitted test.

If an answer sheet is found for a multiple choice test, the test can be automatically graded and students are granted new permissions (allowing drip-feeding content). Simply add an answer sheet for a test in the same format as the submitted answers shown above. Each question is assigned the same number of points resulting in a maximum score of 10 if all questions are answered correctly. Students will be notified about permissions granted by automatically graded tests by email (if enabled in the plugin settings).

The following question types are currently supported:

• Open
• Multiple choice (single answer)
• Upload

The following question types could be added by yourself:

• Multiple choice (multiple answers e.g. using ul instead of ol)
• Fill in the blanks (e.g. using underscores)

The following question types are currently NOT supported:

• Matching
• Sorting

Approving submitted student assignments

You can approve submitted student assignments either by navigating to LMS > Studentassignments in the backend of your October installation. Alternatively you can navigate to LMS > Students and open the tab called Assignments.

Teachers will be notified about submitted work by email (if enabled in the plugin settings).

Grading submitted student tests

You can grade submitted student tests either by navigating to LMS > Studenttests in the backend of your October installation. Alternatively you can navigate to LMS > Students and open the tab called Tests.

Teachers will be notified about submitted work by email (if enabled in the plugin settings).

Granting students permissions

You can grant students permission by navigating to LMS > Students in the backend of your October installation and opening the tab called Student permissions.

It is also possible to create permissions that are automagically granted x-days after students start a course. Students will be notified about scheduled permissions by email (if enabled in the plugin settings).

Email notifications

Plugin settings allow you to activate notifications.

• Teacher receives a notification when student submits an assignment
• Teacher receives a notification when student submits a test
• Student receives a notification when an automagically graded test unlocks a permission
• Student receives a notification when a scheduled permission is unlocked

Available fields:

{{ name }}
{{ course.name }}
{{ course.description }}
etc.

Components

Courses component

This component lists available courses. All courses are listed.

Please see: https://octobercms.com/docs/cms/components

Course component

This component lists all available lessons, assignments and tests for a course by slug.

Lessons, Assignments and tests will become available only if the date criteria are met (drip-feed).

Please see: https://octobercms.com/docs/cms/components

Lesson component

This component shows a lesson by slug.

Please see: https://octobercms.com/docs/cms/components

Assignment component

This component shows an assignment by slug. Assignments allow students to upload a zip archive with comments. Teachers can approve the assignment. If a student has already submitted an assignment, this page shows the result.

Please see: https://octobercms.com/docs/cms/components

Test component

This component shows a test by slug. Tests allow students to submit their answers to the test and optionally upload a zip archive. You can convert a test with HTML markup into a form using javascript (see the example below). The form fields will be joined together to populate the original textarea. If a student has already submitted a test, this page shows the result (inline comments, feedback and grade).

Convert a test with HTML markup into a form

You can convert a test with HTML markup into a form.

• Any questions should be formatted as headings (h1,h2,h3,h4,h5,h6).
• Any multiple choice options should be formatted as items in a list (ul, ol).
• You can use paragraphs and tables, these will remain unchanged.
• If a list only contains a single option it will be converted into an open question.

The contents of the textarea will be updated as students select their answers in the generated form:

1: Option A
2: Option C

This approach allows teachers to add inline comments when grading the test.

NEW If an answer sheet is found for a multiple choice test, the test can be automatically graded and students are granted new permissions (allowing drip-feeding content). Simply add an answer sheet for a test in the same format as shown above. Each question is assigned the same number of points resulting in a maximum score of 10.

Please see: https://octobercms.com/docs/cms/components

Grades component

This component shows a users grades.

Please see: https://octobercms.com/docs/cms/components

Widgets

Note that dashboard widgets are only accessible to backend users who have permission to the LMS and that widgets can also be used on the list pages for courses, students, tests and assignments

Courses widget

The courses widget can be added to the backend dashboard and shows all active courses and the number of students.

Please see: https://octobercms.com/docs/backend/widgets

Assignments widget

The assignments widget can be added to the backend dashboard and shows the most recent assignments.

Please see: https://octobercms.com/docs/backend/widgets

Tests widget

The tests widget can be added to the backend dashboard and shows the most recent tests.

Please see: https://octobercms.com/docs/backend/widgets

Overview widget

The overview widget can be added to the backend dashboard and shows an overview of courses, tests and assignments.

Please see: https://octobercms.com/docs/backend/widgets

Activity widget

The activity widget can be added to the backend dashboard and shows an overview of latest tests and assignments.

Please see: https://octobercms.com/docs/backend/widgets

Extending functionality

Programmatically adding permissions and enrolling students

Please see: https://octobercms.com/docs/database/relations#inserting-related-models

Overwrite partials

You can overwrite the component partials to accommodate the design of your site by placing a copy in the partials folder of the CMS.

Please see: https://octobercms.com/docs/cms/components#customizing-default-markup

Extend backend views

Sometimes you may wish to allow a back-end view file or partial to be extended, such as a toolbar. You can add your own elements to the top of certain backend lists (e.g. to display stats) and the sidebar of certain backend forms (e.g. to display extra information).

The following view events are available to extend backe-end views:

https://octobercms.com/docs/plugin/extending#extending-with-events

Available events

Events allow you to be notified when a student submits an assignment or test or when a teacher grades a test etc.

The following events are available to extend the functionality of this plugin:

Please see: https://octobercms.com/docs/plugin/extending#extending-with-events

Adding form fields

You can extend this plugin with your own to add fields to any backend forms.

Please see: https://octobercms.com/docs/plugin/extending#extending-backend-form

Adding columns to lists

You can extend this plugin with your own to add columns to any backend lists.

Please see: https://octobercms.com/docs/plugin/extending#extending-backend-list

Support

Please use the Support Forum (on the left side of the page for any theme or plugin) or send me a message. I also offer design and development services. You can visit my website for more information. Do not use reviews to ask for support.

IMPORTANT NOTICE! All my activities on October CMS are suspended indefinitely after my second burn-out. I do not offer any support or updates