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
• Wiki component
• Revisions component
• Notification mails
• Available permissions
• Available languages
• Overwrite component partials
• Available events
• Support

Installation

• To install from the Marketplace, click on the "Add to Project" button and then select the project you wish to add it to before updating the project in the backend of your website to pull in the plugin. To install from the backend, go to Settings -> Updates & Plugins -> Install Plugins and then search for Briddle.Wiki.

Getting started

Please note that RainLab.User is required for this plugin.This plugin is FREE.

1. Download Briddle.Wiki (This plugin requires RainLab.User so add this first). This plugin is FREE.
2. Go to Settings -> Wiki in the backend to configure the plugin.
3. Add the components to the page.

The plugin creates .md files and folders in the storage folder. The default folder that is used to store wiki files is called "wiki". Revisions are stored in subfolders by the same name as the subject of a wiki page.

Wiki component

The wiki component should be added to a page (e.g. wiki/:slug?). This plugin does not restrict visitors who are not logged in from viewing the page but to edit/add/delete users must be logged in.

This component also shows a menu to wiki pages (ordered alphabetically) and links to page revisions.

Parameters:

• optional subfolder (allowing you to configure multiple wiki)
• redirect (dropdown for selecting the revision page)
• slug parameter name (no need to change)

Revisions component

The revision component should be added to a page (e.g. revision/:slug*). This plugin does not restrict visitors who are not logged in from viewing the page.

Parameters:

• slug parameter name (no need to change)

Notification mails

If enabled in Settings -> Wiki, you will be notified of Wiki activity.

The briddle.wiki::mail.notify template accepts the following parameters:

• name (name of wiki page)
• user (e.g. user.name)
• folder
• comment
• action (added/updated/deleted)

Available permissions

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

• briddle.wiki.settings

Available languages

This plugin can be translated in any language

This plugin supports the following languages out of the box:

• english

Extending functionality

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

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:

These events include the ID of the RainLab.User performing the action and the name of the wiki page.

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

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.