Overview of the ProBoards v5 Plugin System
Nov 23, 2012 14:56:31 GMT -8
Jordan, Ownage-Gamer, and 5 more like this
Post by VS Admin on Nov 23, 2012 14:56:31 GMT -8
This guide will give a broad overview of the ProBoards v5 Plugin System.
Background
Prior to ProBoards Version 5, modifications to ProBoards forums were done mostly through the Header & Footer codes system. A developer would put together code that accomplished a task and post it for other forum staff to use. The developer would need to provide detailed instructions on how to install the code. This could involve copying/pasting code into Headers & Footers on multiple pages, and was very subject to user error.
We wanted to break away from this system, and create something that was both easy and powerful for developers to use, as well as simple for forum staff. To make a modification to a forum you shouldn't need coding skill. That's where the v5 Plugins System comes in.
Plugins
Plugins are an easy way to install custom codes on a ProBoards forum. A plugin generally consists of Header & Footer codes along with customizable settings. When a developer provides a plugin to a forum staff member, they can download the plugin file (*.pbp files), and import it directly into their forum. When the plugin is enabled, it will automatically insert Header & Footer codes into the correct places on the forum. There is no need for the forum staff to deal with the coding; it has already been handled by the developer.
Further, plugins can offer very easy ways for forum staff to customize various options without needing to touch the actual HTML / JavaScript / CSS code. Plugin authors are given tools to easily build a custom User Interface where forum staff can input settings for the plugin. These settings are stored in variables that can then be accessed by the Header & Footer codes of the plugin.
Plugin Keys
Another great feature of plugins is the ability to store data on ProBoards' servers related to users, threads, posts, conversations, and messages. Previously, when coders wanted to save a preference for a user, or perhaps store data relating to a thread, they would either use cookies or third party websites to store that data. This is no longer needed. Using a couple quick lines of JavaScript, you can get() or set() data which will store it on ProBoards' server.
Conclusion
We hope this overview gives you a good idea of what the ProBoards v5 Plugin System can accomplish. Further guides will be posted soon detailing how to create plugins, and how plugin keys are used.
Background
Prior to ProBoards Version 5, modifications to ProBoards forums were done mostly through the Header & Footer codes system. A developer would put together code that accomplished a task and post it for other forum staff to use. The developer would need to provide detailed instructions on how to install the code. This could involve copying/pasting code into Headers & Footers on multiple pages, and was very subject to user error.
We wanted to break away from this system, and create something that was both easy and powerful for developers to use, as well as simple for forum staff. To make a modification to a forum you shouldn't need coding skill. That's where the v5 Plugins System comes in.
Plugins
Plugins are an easy way to install custom codes on a ProBoards forum. A plugin generally consists of Header & Footer codes along with customizable settings. When a developer provides a plugin to a forum staff member, they can download the plugin file (*.pbp files), and import it directly into their forum. When the plugin is enabled, it will automatically insert Header & Footer codes into the correct places on the forum. There is no need for the forum staff to deal with the coding; it has already been handled by the developer.
Further, plugins can offer very easy ways for forum staff to customize various options without needing to touch the actual HTML / JavaScript / CSS code. Plugin authors are given tools to easily build a custom User Interface where forum staff can input settings for the plugin. These settings are stored in variables that can then be accessed by the Header & Footer codes of the plugin.
Plugin Keys
Another great feature of plugins is the ability to store data on ProBoards' servers related to users, threads, posts, conversations, and messages. Previously, when coders wanted to save a preference for a user, or perhaps store data relating to a thread, they would either use cookies or third party websites to store that data. This is no longer needed. Using a couple quick lines of JavaScript, you can get() or set() data which will store it on ProBoards' server.
Conclusion
We hope this overview gives you a good idea of what the ProBoards v5 Plugin System can accomplish. Further guides will be posted soon detailing how to create plugins, and how plugin keys are used.