71

Product support

Get help in the plugin support forum.

Categories

Wiki Lite

Add a simple flat-file wiki that you can use to create documentation or manuals that a community can contribute to.

Features

I want you to get excited about this plugin and I understand that that will only happen if you can really make it your own.

STATUS FEATURE
YES MULTIPLE WIKI
YES MAIL NOTIFICATIONS
YES GLOBAL PERMISSIONS (edit/add/delete)
YES FLAT FILE WIKI
YES LOGGED-IN USERS CAN ADD, EDIT AND DELETE WIKI
YES THROTTLING (x seconds)
YES BROWSE REVISIONS
YES SUPPORTS MARKDOWN
YES PREVENTS COLLISION BETWEEN MULTIPLE USERS EDITING
YES MULTILINGUAL
YES PERMISSIONS
YES EXTENDABLE (USING EVENTS)
YES THOROUGHLY SUPPORTED
YES CONCISE DOCUMENTATION

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.

Like this plugin?

Did you know that only about 30% of my plugins are paid (70% of my plugins are free) and that 30% of your purchase goes to help fund the October Project? If you purchase this plugin, you can help me to develop it further, provide support for it or make new plugins.

My other plugins include:

Screenshot

Hello, I am Wiego Bergsma. 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! Wiego

Table of contents

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:

STATUS EVENT PARAMETERS
YES briddle.wiki.edit user_id, name, folder
YES briddle.wiki.add user_id, name, folder
YES briddle.wiki.delete user_id, name, folder

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.

1.1.1

Added some aditional parameters to events. Updated docs.

Jul 19, 2020

1.1.0

Added some aditional parameters to the mail view.

Jul 19, 2020

1.0.9

Uh... actually removed the old file-based list from the views :)

Jul 19, 2020

1.0.8

Added comments to revisions and replaced the list of revisions generated by files with parsing a YAML file that stores revisions.

Jul 19, 2020

1.0.7

Added setting to disable creating revisions when updating or deleting.

Jul 16, 2020

1.0.6

Added support for multiple wiki using component parameter.

Jul 16, 2020

1.0.5

Made the color parameter from the settings page available to views (not implemented in the views).

Jul 16, 2020

1.0.4

Added tabs (page and revisions) to views and added name of wiki to events. Also added mail notifications nd global permissions.

Jul 16, 2020

1.0.3

Added missing translation.

Jul 15, 2020

1.0.2

Updated docs.

Jul 15, 2020

1.0.1

Initialize plugin.

Jul 15, 2020