Help15:Screen.plugins.edit.15

How to Access

Navigate to the Plugin Manager. Click on the Plugin Name or click on the Plugin's checkbox and press the Edit button on the toolbar.

Description

This is where you can edit details and parameters for Plugins. Some Plugins have parameters and others don't have any.

Screenshot

Details

The Details section is the same for all Plugins, as follows:

• Name. The Name of the Plugin.
• Enabled. Whether or not this Plugin is enabled.
• Type. The Type of the Plugin. This value cannot be changed.
• Plugin File. The name of the Plugin file. Each Plugin has two files with this name. One has the file extension ".php" and the other has the file extension ".xml".

• Access Level. Who has access to this item. Current options are:
  • Public: Everyone has access
  • Registered: Only registered users have access
  • Special: Only users with author status or higher have access

Enter the desired level using the drop-down list box.

• Order. The order this item will display in the Manager screen. Use the drop-down list box to change the Order. You can select 'First' or 'Last' to make this the first or last item. Or you can select an item from the list. In this case, the current item will be listed just after the item you select. Note that the Order can also be changed in the Manager screen.
• Description. The description of what this Plugin does. This cannot be changed.

Plugin Description and Parameters

When Joomla! is installed, 32 Plugins are included in the installation. These are described below, along with any parameters for the Plugin.

Authentication - Joomla

This Plugin processes the default User Authentication in Joomla!. It has no parameters.

Authentication - LDAP

This Plugin processes User Authentication against an LDAP server. It has the following parameters:

• Host. The host URL. For example, "openklap.mycompany.org".
• Port. The port number. The default is 389.
• LDAP V3. Whether or not this host uses LDAP version 3. The default is LDAP V2.
• Negotiate TLS. Whether or not to use TLS encryption with this host. If set to "Yes", all traffic to and from this server must be encrypted.
• Follow Referrals. Whether to set the LDAP_OPT_REFERRALS flag to Yes or No. For Windows 2003 hosts this must be set to No.
• Authorization Method. "Bind Directly as User" or "Bind and Search".
• Base DN. The Base DN of your LDAP server.
• Search String. A query string used to search for a given User. The [search] keyword is replaced by the login typed by the User. For example: "uid=[search]". More than one Search String can be entered. Separate each by a semi-colon ";" character. This is only used when searching.
• Users DN. The [username] keyword is dynamically replaced by the username typed by the User. An example string is: "uid=[username], dc=[my-domain], dc=[com]". More than one string can be entered. Separate each with a semi-colon ";" character. This is only used if the Authorization Method above is set to "Bind Directly as User".
• Connect username and Connect password. These define connection parameters for the DN lookup phase. For anonymous lookup, leave both of these fields blank. For an Administrative Connection, the "Connect username" is the username of an administrative account (for example, "Administrator"). In this case, the "Connect password" is the actual password to this administrative account.
• Map: Full Name. The LDAP attribute that contains the User's full name.
• Map:E-mail. The LDAP attribute that contains the User's e-mail address.
• Map: User ID. The LDAP attribute that contains the User's login ID. For Active Directory, this is "sAMAccountName".

Authentication - OpenID

This Plugin processes user authentication with an OpenID. It requires PHP version 5 or above. This Plugin has no parameters.

Authentication - GMail

This Plugin processes User Authentication with a GMail account. It requires that the cURL software package be installed.

Content - Page Navigation

This Plugin enables you to add the Next & Previous functionality to an Article. It has the following parameter:

• Position. Position of the navigation link. Options are "Above" the Article or "Below" the Article.

Content - Rating

This Plugin adds the Voting functionality to Articles. It has no Parameters.

Content - Email Cloaking

This Plugin cloaks all e-mails in content from spambots using JavaScript. This helps prevent e-mails contained in the site from being added to spam e-mail lists. It has the following parameter:

• Mode. How the e-mails will be displayed. Options are "As linkable mailto address" or as "Non-Linkable text".

Content - Code Hightlighter (GeSHi)

This Plugin displays formatted code in Articles based on the GeSHi highlighting engine. It has no parameters.

Content - Load Module

This Plugin allows you to place a Module inside an Article with the syntax: {loadposition xx}, where "xx" is a user-defined position code. For example, if you create a Module with the Position value of "myposition1", then typing the text "{loadposition myposition1}" inside an Article will cause that Module to show at that point in the Article.

This Plugin has the following parameters:

• Enable Plugin. Whether or not to enable this Plugin.
• Style. The Style for the loaded Module.

Content - Pagebreak

This Plugin adds table of contents functionality to a paginated Article. This is done automatically through the use of the Pagebreak button added to the lower part of the text panel in an Article. The HTML code is included here as a reference of what is available. The Pagebreak will itself display in the text window as a simple horizontal line.

 
 Syntax: Usage: <hr class="system-pagebreak" />
 <hr class="system-pagebreak" title="The page title" /> or 
 <hr class="system-pagebreak" alt="The first page" /> or 
 <hr class="system-pagebreak" title="The page title" alt="The first page" /> or 
 <hr class="system-pagebreak" alt="The first page" title="The page title" /> 
 

This Plugin has the following parameters:

Toolbar