Actions

Help15

Screen.plugins.edit.15

From Joomla! Documentation

Revision as of 12:29, 25 June 2008 by Dextercowley (Talk | contribs)

Contents

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

Plugin edit.png

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:

Plugin ldap parameters.png

  • 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:

Plugin page nav parameters.png

  • 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: Plugin email cloaking parameters.png

  • 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. See Module Manager - New/Edit for more information about showing Modules inside Articles.

This Plugin has the following parameters:

Plugin load module parameters.png

  • 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:

Plugin pagebreak parameters.png

  • Enable Plugin. Whether or not to enable this Plugin.
  • Site Title. Whether or not the title and heading attributes from the Plugin will be added to the Site Title tag.
  • Table of Contents. Whether to Hide or Show a table of contents for multi-page Articles.
  • Show all. Whether or not to give Users the option to show all pages of an Article.

Editor - No Editor

This Plugin loads a basic text editor. This option can be used when you are pasting HTML code from another source and you don't want the HTML to be altered by a WYSIWYG editor. This Plugin has no Parameters.

Editor - TinyMCE 2.0

This Plugin loads the TinyMCE 2.0 editor. This is the default editor in Joomla!. This Plugin has the following Plugin parameters:

Plugin tinymce parameters.png

  • Functionality. Select "Advanced" or "Simple" functionality. With "Simple" selected, the User has only 9 toolbar buttons: Bold, Italic, Underline, Strikethrough, Undo, Re-do, Clean up messy code, Bullets, and Numbering. With "Advanced" selected, the User has all of the TinyMCE toolbar buttons. "Advanced" is the default setting.
  • Code Cleanup on Startup. Whether or not to automatically clean up the HTML code when the editor first loads. Default value is "Off".
  • Code Cleanup on save. Whether to run HTML code cleanup when a file is saved. Options are "Never", "Front Only", and "Always". The default setting is "Always".
  • Do not clean HTML entities. Whether or not to skip cleaning of HTML entities. The default value is "No", which means that HTML entities will be stripped from the file.
  • Save Warning. Whether or not to give a warning if the User cancels without saving the file. The default value is "Off".
  • Compressed Version. Whether or not to use the compressed version of TinyMCE. Note that this does not work reliably with Windows IE, so "Off" is the recommended setting and is the default.
  • URLs. Whether to use Relative or Absolute URLs for links. The default is "Relative".
  • Text Direction. Whether the language reads "Left to Right" or "Right to Left" (for example, like Arabic). Default is "Left to Right".
  • Automatic Language Selection. Whether or not to match the selected UI language. Do not set to "Yes" unless the appropriate editor languages are installed. Default is "No".
  • Language Code. Editor UI language code. This must be entered if Automatic Language Selection is "Off". Default is "en" for British English.
  • Prohibited Elements. The elements that will be cleaned from the text. Default is "applet", which will remove applet elements from the text.
  • Template CSS classes. Whether or not to load the "editor.css" file. If no such file is found for the default template, the "editor.css" file from the system template is used. Default is "Yes".
  • Custom CSS Classes. Optional full URL path to a custom CSS file. If entered, this overrides the Template CSS classes setting.
  • New Lines. Whether to interpret new lines as "P Elements" or "BR Elements". Default is "P Elements".
  • Extended Valid Elements. Optional list of valid HTML elements to add to the existing rule set.

This Plugin has the following advanced parameters:

Plugin tinymce advanced.png

  • Horizontal Rule. Whether to Hide or Show the Horizontal Rule button.

The following settings only apply if the editor is in Advanced mode.

  • Smilies. Whether to Hide or Show the Smilies button.
  • Table. Whether to Hide or Show the Table control buttons.
  • Style. Whether to Hide or Show the CSS Style button.
  • Layer. Whether to Hide or Show the Layer control button.
  • XHTMLxtras. Whether to Hide or Show the additional XHTML features.
  • Template. Whether to Hide or Show the Template button.
  • Directionality. Whether to Hide or Show the Directionality button.
  • Fullscreen. Whether to Hide or Show the Fullscreen button.
  • HTML Height. The height, in pixels, of the HTML mode pop-up window.
  • HTML Width. The width, in pixels, of the HTML mode pop-up window.
  • Preview. Whether to Hide or Show the Preview button.
  • Element Path. If set to "On", show the Set Classes button for the marked text.
  • Insert Date. Whether to Hide or Show the Insert Date button.
  • Date Format. The Date format to use for Insert Date.
  • Insert Time. Whether to Hide or Show the Insert Time button.
  • Date Format. The Time format to use for Insert Time.

Editor - XStandard Lite 2.0

This Plugin provides the XStandard editor. It has the following parameters:

Plugin xstandard parameters.png

  • Editor Mode. Three modes of operation are possible: WYSIWYG, Source, or Screen Reader.
  • Word Wrap. Whether to have Word Wrap turned Off or On.

Editor Button - Image

This Plugin displays the Image button below the editor box when you are using a Joomla! editor (for example, when writing an Article). It allows you to insert an image into an Article. This Plugin has no parameters.

Editor Button - Pagebreak

This Plugin displays the Pagebreak button below the editor box when you are using a Joomla! editor (for example, when writing an Article). It inserts a page break in the Article. This Plugin has no parameters.

Editor Button - Readmore

This Plugin displays the "Read more..." button below the editor box when you are using a Joomla! editor (for example, when writing an Article). It inserts a "read more..." break in the Article that allows you to display just the first portion of an Article on a page. This Plugin has no parameters.

Search - Content

This Plugin enables Articles to be searched. It has the following parameters:

Plugin search parameters.png

  • Search Limit. The maximum number of search results to return after a search is done.
  • Articles. Whether or not to search Articles.
  • Uncategorized Articles. Whether or not to search Uncategorized Articles.
  • Archived Articles. Whether or not to search Archived Articles.

Search - Weblinks

This Plugin enables Web Links to be searched. It has the following parameters:

Plugin search weblinks parameters.png

  • Search Limit. The maximum number of search results to return after a search is done.

Search - Contacts

This Plugin enables Contacts to be searched. It has the following parameters:

Plugin search weblinks parameters.png

  • Search Limit. The maximum number of search results to return after a search is done.

Search - Categories

This Plugin enables Category information to be searched. It has the following parameters:

Plugin search weblinks parameters.png

  • Search Limit. The maximum number of search results to return after a search is done.

Search - Sections

This Plugin enables Section information to be searched. It has the following parameters:

Plugin search weblinks parameters.png

  • Search Limit. The maximum number of search results to return after a search is done.

Search - Newsfeeds

This Plugin enables News Feeds to be searched. It has the following parameters:

Plugin search weblinks parameters.png

  • Search Limit. The maximum number of search results to return after a search is done.

System - SEF

This Plugin adds SEF support to links in the document. It operates directly on the HTML and does not require a special tag. This Plugin has no parameters.

System - Debug

This Plugin provides debugging information. It has the following parameters:

Plugin debug parameters.png

  • Display SQL query log. Whether or not to include the SQL query log in the debug information.
  • Display memory usage. Whether or not to include memory usage data in the debug information.
  • Display undefined language strings. Whether or not to include undefined language strings in the debug information.

System - Legacy

This Plugin allows you to use Extensions in "1.5 Legacy" mode. Note that this Plugin is disabled by default and must be enabled before you can use this type of Extension. This Plugin has the following parameters:

Plugin legacy parameters.png

  • Use Legacy URL Rouging. Whether or not to use the legacy URL routing mechanism for legacy Extensions. The default value is "No".

System - Cache

This Plugin provides for page caching. Page caching allows the web server to save snapshots of pages and use them when serving web pages. This improves the performance of your web site and reduces the workload of the server. This Plugin has the following parameters:

Plugin cache parameters.png

  • Use Browser Caching. Whether or not to use the mechanism for storing a page cache in the local browser. Default is "No".
  • Cache Lifetime. The time, in minutes, to save a cached page. Default is 15 minutes.

System - Log

This Plugin provides for system logging. A log is a file that contains information about the web site activity. It can be used to identify see a history of activity and to troubleshoot problems on the site. This Plugin has no parameters.

System - Remember Me

System - Backlink

User - Joomla!

XML-RPC - Joomla

XML-RPC - Blogger API

Toolbar

Plugin edit toolbar.png

Quick Tips

Related Information