How to add a Plugin to a page

Overview

The content and functionality on a page is usually defined by the Plugins placed upon it.

Plugins that can be placed on the page may have multiple configurations. These configurations are called Plugin Instances. Plugin Instances enable one Plugin to be used in multiple locations and offer different functionality in each location. An example of this is when the Menu Plugin is used to provide both a main menu and a side menu. Typically, the main menu will output the top levels of the menu tree whilst the side menu will enable access to the lower levels. Each menu will use a different Plugin Instance each configured to provide the required functionality.

How can I add a Plugin Instance?

1. Login as an Admin and open the page you wish to add the Plugin Instance to.

2. In Slot Mode, click on the "Add a Plugin into the Slot" button located at the top left corner of the Slot where you want to add the plugin.

3. You have three options when you add the Plugin Instance:

- at Item Level: Add the Plugin Instance at Item Level if you want the Plugin Instance to display only in the page you are working on.
If this is the case, click the "Select Plugin Instance..." button below this option.

- at Template Level: Add the Plugin Instance at Template Level if you want the Plugin Instance to display in all the pages that have the same Template used in the page you are working on
(e.g. the Plugin Instance will display in all pages using the template HTML-3-col.tpl.php).
If this is the case, click the "Select Plugin Instance..." button below this option.

- at Template Family Level: Add the Plugin Instance at Template Family Level if you want the Plugin Instance to display in all the pages that have the same Template Family used in the page you are working on
(e.g. the Plugin Instance will display in all pages of your website that use the same template family).
If this is the case, click the "Select Plugin Instance..." button below this option.

4. Select the Plugin you want to add then click the "View Instances" button.

5. Select the Instance and click the "Choose" button.

6. Click the "Save" button.

For Plugins added at Template Level or Template Family level, a warning message will let you know the number of pages that will be affected on this change.

Click the "Save" button if you want to proceed, otherwise click "Cancel".