Documentation

Overview

Community Builder Plugin Management Edit interface.

Description

In this screen you edit an existing CB Plugin.

How to access

You can access the Community Builder Plugin Management Edit page by clicking on the top menu bar, Components → Community Builder → Plugin Management or Community Builder → Plugin Management and clicking in the New button or selecting an existing plugin (ticking on the check-box) and clicking on the edit button.

Details

Each CB plugin has two main tabs of its own containing configuration parameters:

1. Global. Contains basic configuration parameters for each CB plugin.
2. Parameters. Contains CB plugin specific configuration parameters. 

Screenshot

Global tab Settings

The Global tab of every Community Builder tab has the following settings:

1. Name. The name of the plugin.
2. Description. The description of the plugin taken from its xml file. This is a readonly parameter.
3. Publish. A Yes/No toggle button to publish or unpublish the plugin.
4. Acess Level. A drop-down parameter used to specify the acces viewing level of the plugin.
5. Ordering. Specifies the ordering of the plugin compared to other plugins.
6. Type. The plugin type taken from the plugin xml file. This is a readonly parameter.
7. Folder. The plugin folder name (taken from the xml file) storing the plugin files. This is a readonly parameter.
8. Element. The element name of the plugin (taken from the xml file). This is a readonly parameter.
9. Version. The version number of the plugin. This is a readonly parameter.

Note: Some plugins cannot be unpublished.

Parameters tab Settings

Each Community Builder core plugin my have its own application specific settings in its Parameter tab area. Such plugins along with their parameter tab setting options follow.

CB Menu

Screenshot

The CB Menu plugin Parameters tab has the following options:

1. Menu display type. Lets you specify how the menu should be rendered based on following settings:
   1. Menu Bar.
   2. Menu List table 2 columns.
   3. Menu List table 1 column.
   4. Menu List ui-li-spans.
   5. No Display.
2. Status display type. Following options are available:
   1. Menu List table 2 columns.
   2. Menu List table 1 column.
   3. Status List ui-li-spans.
   4. No Display.

Articles Parameters General

Screenshot

The following configuration settings are available in the CB Articles plugin Parameters General tab:

1. Template. Select the articles plugin template that should apply. The plugin only has one preconfigured (default).
2. Class. Optionally adds a class suffix to surrounding div for each article row.

Articles Parameters Articles

Screenshot

The following configuration settings are available in the CB Articles plugin Parameters Articles tab:

1. Model. Following options are available:
   1. Auto Detect.
   2. Joomla.
   3. K2. 
2. Exclude Categories. Select one or more Joomla or K2 categories to be excluded from available blog category options.

Private Message System

Screenshot

The Private Message System Parameters tab has the following settings:

1. PMS component type. Available settings are:
   1. MyPMS OpenSource
   2. PMS Pro.
   3. PMS Enhanced 2.x.
   4. uddeIM 0.4.
   5. uddeIM 1.0 and 2.0+ or better.
   6. JIM 1.0.1.
2. PMS Send Menu/Link text.
3. PMS Send Menu/Link description.
4. PMS Inbox Menu/Link text.
5. PMS Inbox Menu/Link description.
6. PMS Outbox Menu/Link text.
7. PMS Outbox Menu/Link description.
8. PMS Trash Menu/Link text.
9. PMS Trash Menu/Link description.
10. PMS Options Menu/Link text.
11. PMS Options Menu/Link description.
12. PMS User Deletion. The following options are available:
    1. Keep all messages.
    2. Remove all messages (received and sent).
    3. Remove received messages only.
    4. Remove sent messages only.
13. PMS Deletion function to use. Options are:
    1. Use CB PLugin function. Uses code function in the CB plugin to remove messages.
    2. Use PMS component function. Use code function from Private Message System component to remove messages.

Blogs Parameters General

Screenshot

The following configuration settings are available in the CB Blogs Parameters General tab:

1. Template. Select the template to be used for the blog tab. Only one template is available ('default').
2. Class. Optionally adds a class suffix to surrounding div for each blog row. 

Blog Parameters Blog

screenshot

The following settings are available in the CB Blogs plugin Parameters Blogs tab:

1. Model. Available options are:
   1. Internal.
   2. Joomla.
   3. K2.
2. Mode. Options are:
   1. Intro & Full.
   2. Intro Only.
   3. Full Only.
3. Categories (internal).
   Categories (Joomla/K2).
4. Create Access.
5. Create Limit.
6. Approval.
7. Captcha.
8. Auto Delete.

Blog Parameters Defaults

Screenshot

The CB Blogs plugin Parameters Default settings have the following options:

1. Category.
2. Category Display.
3. Access.
4. Access Display.

Forums Parameters General 

Screenshot

The following settings are available on the CB Forums plugin Parameters General tab:

1. Template.
2. Class.

Forums Parameters Forums

Screenshot

The CB Forums plugin has the following settings available on the Forums Paremeters Forums tab:

1. Model. The model selection has the following options:
   1. Auto Detect
   2. Kunena 2.x
   3. Kunena 3.x

Profile tab

(appears when model is set to Kunena). The following options are available to select mapping CB fields:
1. Ordering.
2. Viewtype.
3. Signature.
4. Personal Text.
5. Gender.
6. Birthdate.
7. Location.
8. ICQ.
9. AIM.
10. YIM.
11. MSN.
12. Skype.
13. Twitter.
14. Facebook.
15. Gtalk.
16. MySpace.
17. LinkedIn.
18. Delicious.
19. FriendFeed.
20. Digg.
21. Blogspot.
22. Flickr.
23. Bebo.
24. Website.
25. Hide Email.
26. Show Online.

Sidebar tab

(appears when model is set to Kunena). The following options are available to map CB substitution supported sidebar areas:
1. Registered.
2. Anonymous.
3. Deleted.

Toolbar

At the top you will see the toolbar:

The functions are:

• Install CB Plugin. Go to CB Plugin installation page.
• Edit. Edit selected plugin.
• Publish. Publish selected plugins.
• Unpublish. Publish selected plugins.
• Delete. Delete selected plugins.
• Close. Closes form and returns to previous page.
• Help. Opens this help page.
• Permissions. Opens permissions settings for this page.

Quick Tips

• TBS

Related information

• Plugin Management help page