05th November, 2014 by Samuel Watts

Installing a plugin.

Once you have created your plugin you are going to need to install it. Installing the plugin enables Envisage to find it and enable the user to add it to their site.

Installing a plugin backend

The first thing we need to do is add our plugin to our web.config.

The web.config file is the config used to store the general settings for the website. This is where all controls and plugins are referenced. The web.config file can be found in the webroot of the site.

"<webroot>/web.config"

Web Config

Within the web.config file we need to navigate to the '<pages><controls>' section, this is where all plugins and controls are referenced.

< pages controlrenderingcompatibilityversion="3.5" clientidmode="AutoID" enableeventvalidation="false" validaterequest="false">
     < controls>
     <  ontrols="">
<  ages="">
Inside the controls section we will need to add a line to reference our plugin. Using the example form (Link) how to create a simple (LINK) we are going to add our LatestNewsPanel plugin to the config.
< add tagprefix="Envisage" tagname="LatestNewsPanel" src="~\Plugins\LatestNewsPanel\LatestNewsPanel.ascx">
[ ParseChildren(true), ToolboxData("<{0}:latestnewspanel runat="server">")]
[ EnvisageControlInfo{"LatestNewsPanel", "", "Latest News Widget", "news", "Envisage", true)]

The line above is what we will need to add in order for envisage to recognise our plugin. The value has a few properties this include.

tagPrefix - this is the prefix used when outputting the plugin to the website, this is referenced by plugin as per the ToolboxData property we created when first creating the plugin, as shown below:

~\Plugins\LatestNewsPanel\LatestNewsPanel.ascx
tagName - This is the name of hte plugin, again this is referenced in the plugin settings when we created it under the EnvisageControlInfo, as shown below:
<>
Src - this is the source location of your plugin, in this instance:

The (~) symbol references the webroot of the website:, the plugin can be found as below:

Webroot Source

Installing the plugin front end

Now that envisage can see our plugin through the web.config, we need to install our plugin on the front end through envisage. All plugin installations are done through the admin dashboard, this can be found at any time from the last menu item on the left hand menu, as shown below:

Settings Tab

Within the admin dashboard, we need to navigate to the system config, which is under the system settings, this can be found as below.

System Settings

About author

Samuel Watts

Sam is our resident video games expert. as well as being a dab hand (Or should that be knee) at muay thai. He is the man on the end of the phone dealing with your support requests.

Comment
We are always here to help you. Don’t hesitate to contact us anytime!

01202 555124 or hello@envisagecms.co.uk