Actions

Help25

Difference between revisions of "Extensions Plugin Manager Edit"

From Joomla! Documentation

(Created page with "==How to Access== Navigate to the Plug-in Manager. Click on the Plug-in's Name or click on the Plug-in's checkbox and press the Edit button i...")
 
m (Related Information: category reorganizing)
(One intermediate revision by one user not shown)
Line 28: Line 28:
 
At the top right you will see the toolbar:
 
At the top right you will see the toolbar:
  
[[Image:Help25-plugin_manager-edit-toolbar.png]]
+
[[Image:Help25-Toolbar-Save-SaveClose-Close-Help.png]]
* '''Save.''' Save it and return to editing the plug-in details.
+
 
* '''Save & Close.''' Save it and return to the previous screen. If you have been working on a screen for a long time and don't want to risk losing your work, pressing ''Save & Close'' saves your work and lets you continue working. If, for example, you lost your Internet connection, your work will be saved up to this point.
+
The functions are:
* '''Close.''' Return to the previous screen without saving your work. If you press ''Close'' while adding a new item, this new item will not be created. If you were modifying an existing item, the modifications will not be saved.
+
{{Chunk25:Help_screen_toolbar_icon_Save|plug-in}}
* '''Help.''' Opens this Help Screen.
+
{{Chunk25:Help_screen_toolbar_icon_SaveAndClose|plug-in}}
 +
{{Chunk25:Help_screen_toolbar_icon_Cancel}}
 +
{{Chunk25:Help_screen_toolbar_icon_Help}}
  
 
==Plug-in Descriptions and Options==
 
==Plug-in Descriptions and Options==
Line 339: Line 341:
 
*To uninstall third-party Plug-ins: [[Help25:Extensions_Extension_Manager_Manage|Extension Manager - Manage]]
 
*To uninstall third-party Plug-ins: [[Help25:Extensions_Extension_Manager_Manage|Extension Manager - Manage]]
  
<noinclude>{{cathelp|2.5|Plugin Manager|Extensions}}</noinclude>
+
<noinclude>{{cathelp|2.5|Plugin Manager Help Screens|Extensions Help Screens}}</noinclude>

Revision as of 16:57, 4 August 2012

Contents

How to Access

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

Description

This screen allows you to edit the details and options for plug-ins. Some plug-ins have several configurable options, while others may not have any.

Screenshot

Help25-plugin manager-edit-screen.png

Details

The Details section is the same for all plug-ins and has the following fields:

  • Plug-in Name. The Name of the Plug-in.
  • Enabled. Whether or not this Plug-in is enabled.
  • Access. Which user 'access levels' have access to this item. You can change an item's Access Level by clicking on its name to open it up for editing. The default user 'access levels' which come preconfigured with Joomla! are:
    • Public: Everyone has access including website visitors who have not logged in
    • Registered: Only users with registered status or higher will have access
    • Special: Only users with author status or higher have access
  • Ordering. A drop-down list of plug-ins of the same Type. The list of plug-ins is arranged by their current order. You can change this plug-in's order in relation to the other plug-ins by selecting the plug-in in the drop-down list that you want this plug-in to be ordered below.
  • Plug-in Type. The Type of the Plug-in. This value cannot be changed.
  • Plug-in File. The name of the Plug-in file. Each Plug-in has two files with this name. One has the file extension '.php' and the other has the file extension '.xml'.
  • ID. The Plug-in's ID number. This is a unique identification number for this item assigned automatically by Joomla!. It is used to identify the item internally, for example in internal links. You cannot change this number.
  • Description. The description of what this Plug-in does. This cannot be changed. The developer of the plug-in specifies this. This may be blank if the developer did not specify a description for the plug-in.

Options

If the plug-in has configurable options they will appear to the right of the details section. Usually you will see Basic Options which are general options which need to be configured for the basic operation of the plug-in. You may also see Advanced Options which are additional configurable options available for the plug-in which allows further customization of the plug-in. Finally you may see Language Options which are options related to the language functions of your Joomla! installation.

Toolbar

At the top right you will see the toolbar:

Help25-Toolbar-Save-SaveClose-Close-Help.png

The functions are:

  • Save. Saves the plug-in and stays in the current screen.
  • Save & Close. Saves the plug-in and closes the current screen.
  • Cancel/Close. Closes the current screen and returns to the previous screen without saving any modifications you may have made.
  • Help. Opens this help screen.

Plug-in Descriptions and Options

When Joomla! is installed, many plug-ins are included in the installation. These are described below, along with any options for the plug-in.

Authentication - Joomla

This plug-in processes the default User Authentication method in Joomla!. It has no options.

Authentication - GMail

This plug-in processes User Authentication using GMail accounts. It has the following options:

Help25-plugin manager-edit-gmail-options-screen.png

  • Apply Username Suffix. This options allows you to automatically apply a suffix to the username a person enters when they log into your Joomla! installation. The suffix is the portion of the email address after the @ symbol.
  • Username Suffix. This is the suffix portion of the GMail email addresses which will be used to log into your site. This is the portion of the mail address after the @ symbol. Usually you will set this to gmail.com for regular GMail accounts. This option is present to allow you to use other GMail accounts that don't end in the typical gmail.com suffix. This would be the case with Google Apps for Domains email accounts.
  • Verify Peer. When your Joomla! installation attempts to verify the entered Gmail username it does so over an SSL connection. This option configures whether or not your Joomla! installation will check to ensure the CA certificate of the SSL connection is valid before proceeding with verification of the entered username/password. In some situations certificate verification fails in which case you can try setting this option to No to try to fix this.
  • User Blacklist. A comma separated list of usernames not allowed to log into your Joomla! installation.

To use the GMail plug-in:

  • Create a Joomla! user account with the same username as a GMail account user. For example if the GMail email address of the person you want to add is bob1234@gmail.com you would create the Joomla! user account with the username bob1234.
  • Enable the GMail Plug-in.
  • Logout of Joomla!.
  • Login using the GMail username (without "@gmail.com") and the GMail password.

Authentication - LDAP

This plug-in processes User Authentication against an LDAP server. It has the following options:

Help25-plugin manager-edit-ldap-options-screen.png

  • Host. The host URL. For example, "openldap.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.
  • User's 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 has the following options:

File:Help25-plugin manager-edit-openid-options-screen.png

  • Convert Old Usernames. Convert old usernames to the proper OpenID format. Set this to Yes if you upgraded your Joomla! installation from one that was already using OpenID authentication.
  • Require Policy phishing-resistant. Requires the OpenID Provider to be configured with the OpenID Provider Authentication Policy Extension Phishing-Resistant Authentication policy.
  • Require Policy multi-factor. Requires the OpenID Provider to be configured with the OpenID Provider Authentication Policy Extension Multi-Factor Authentication policy.
  • Require Policy multi-factor-physical. Requires the OpenID Provider to be configured with the OpenID Provider Authentication Policy Extension Physical Multi-Factor Authentication policy.

Content - Email Cloaking

This plug-in cloaks all e-mails in content from spambots using JavaScript. This helps prevent e-mails contained in articles from being added to spam e-mail lists. You can disable Email Cloaking inside an article by inserting {emailcloak=off} anywhere in the text of the article. In this case, no e-mail addresses in the article will be cloaked by this plug-in.

Email Cloaking has the following options:

Help25-plugin manager-edit-email cloaking-options-screen.png

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

Content - Code Highlighter (GeSHi)

This plug-in displays formatted code in Articles based on the GeSHi highlighting engine. It has no options.

Syntax usage :
<pre xml:lang="php">
echo $test;
</pre>

Content - Load Modules

This plug-in 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 plug-in has the following option:

Help25-plugin manager-edit-load modules-options-screen.png

  • Style. The Style for the loaded Module.

Content - Pagebreak

This plug-in 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 plug-in has the following options:

Help25-plugin manager-edit-pagebreak-options-screen.png

  • Show Site Title. Whether or not the title and heading attributes from the plug-in 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.

Content - Page Navigation

This plug-in allows you to add Next & Previous navigation links to Articles, for example when using a blog or list layout. This feature can be controlled with the following Joomla! parameters:

Note that, if the Page Navigation plug-in is disabled in this screen, no Page Navigation will show and the parameter settings above will have no effect.

This plug-in has the following option:

Help25-plugin manager-edit-page navigation-options-screen.png

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

Content - Vote

This plug-in adds the Voting functionality to Articles. It has no options.

Editor - CodeMirror

This plug-in loads the CodeMirror editor. CodeMirror is a code editor which provides an editor more suited for source code. It provides code syntax highlighting for many programming languages. It can show you mismatched tags and also helps you maintain consistent indenting of your code. It has the following options:

Help25-plugin manager-edit-codemirror-options-screen.png

  • List numbers. Display line numbers in the editor.
  • Tab mode. Causes tab to adjust the indentation of the selection or current line using the current parser's rules

Editor - None

This plug-in 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 plug-in has no options.

Editor - TinyMCE

This plug-in loads the TinyMCE editor. This is the default editor in Joomla!.

Plugin.Tinymce Output.png

This plug-in has the following options:

Help25-plugin manager-edit-tinymce-basic-options-screen.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.
  • Skin. Choose the skin which will be applied to the TinyMCE editor when displayed in your website.
  • 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.
  • 'Clean code on load. Whether or not to automatically clean up the HTML code when the editor first loads. Default value is "Off".
  • Clean code 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".
  • Entity Encoding.
  • 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.
  • Text Direction. Whether the language reads "Left to Right" or "Right to Left" (for example, like Arabic). Default is "Left to Right".
  • 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.
  • URLs. Whether to use Relative or Absolute URLs for links. The default is "Relative".
  • New Lines. Whether to interpret new lines as "P Elements" or "BR Elements". Default is "P Elements".
  • Prohibited Elements. The elements that will be cleaned from the text. Default is "applet", which will remove applet elements from the text.
  • Extended Valid Elements. Optional list of valid HTML elements to add to the existing rule set.

This plug-in has the following advanced options:

Help25-plugin manager-edit-tinymce-advanced-options-screen.png

  • Toolbar. Whether to show the toolbar above or below the editor window.
  • Toolbar align.
  • 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.
  • Element Path. If set to "On", show the 'Set Classes' button for the marked text.

The following options only apply if the editor is in Extended Mode.

  • Fonts. Hide or Show the 'Font' button.
  • Paste. Hide or Show the 'Paste' button.
  • Search-Replace. Hide or Show the 'Search and Replace' button.
  • Insert Date. Hide or Show the 'Insert Date' button.
  • Date Format. The Date format to use for Insert Date.
  • Insert Time. Hide or Show the 'Insert Time' button.
  • Time Format. The Time format to use for Insert Time.
  • Colors. Hide or Show the 'Colors' control buttons.
  • Table. Hide or Show the Table buttons.
  • Smilies. Hide or Show the 'Smilies' button.
  • Media. Hide or Show the 'Media' button.
  • Horizontal Rule. Hide or Show the 'Horizontal Rule' button.
  • Directionality. Hide or Show the 'Directionality' button.
  • Fullscreen. Hide or Show the 'Fullscreen' button.
  • Style. Hide or Show the 'CSS Style' button.
  • Layer. Hide or Show the Layer buttons.
  • XHTMLxtras. Hide or Show the additional XHTML features.
  • Visualchars. Show invisible characters, specifically non-breaking spaces.
  • Nonbreaking. Insert non-breaking space entities.
  • Template. Hide or Show the 'Template' button.
  • Blockquote. Turn on/off block quotes.
  • Wordcount. Turn on/off word count.
  • Advanced image. Turn on/off a more advanced image dialog box.
  • Advanced link. Turn on/off a more advanced link dialog box.
  • Advanced List. Turn on/off the ability to set number formats and bullet types in ordered and unordered lists.
  • Save Warning. Whether or not to give a warning if the User cancels without saving the file. The default value is "Off".
  • Context menu. Turn on/off the context menu.
  • Inline popups. Turn on/off dialogs opening as floating DIV layers instead of popup windows. This option is useful to allow getting around popup blockers.
  • Custom plugin. Add custom TinyMCE plug-ins to the editor by specifying them here.
  • Custom button. Add custom TinyMCE buttons to the editor by specifying them here.

Button - Article

This plug-in displays the Article button below the editor box when you are using a Joomla! editor (for example, when writing an Article). It allows you to insert an Article link into an Article. This plug-in has no options.

Button - Image

This plug-in 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 plug-in has no options.

Button - Pagebreak

This plug-in 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 plug-in has no options.

Button - Readmore

This plug-in 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 plug-in has no options.

Extension - Joomla

This plug-in manages the update sites for extensions. This plug-in has no options.

Search - Categories

This plug-in enables searching for Category information. It has the following options:

Help25-plugin manager-edit-categories-options-screen.png

  • Search Limit. The maximum number of search results to return after a search is done.
  • Search Published. Whether or not to include published items in the search results.
  • Search Archived. Whether or not to include archived items in the search results.

Search - Contacts

This plug-in enables searching for Contacts. It has the following options:

Help25-plugin manager-edit-contacts-options-screen.png

  • Search Limit. The maximum number of search results to return after a search is done.
  • Search Published. Whether or not to include published items in the search results.
  • Search Archived. Whether or not to include archived items in the search results.

Search - Content

This plug-in enables searching for Articles. It has the following options:

Help25-plugin manager-edit-content-options-screen.png

  • Search Limit. The maximum number of search results to return after a search is done.
  • Articles. Whether or not to enable searching of all articles.
  • Archived Articles. Whether or not to include archived articles in the search results.

Search - Newsfeeds

This plug-in enables searching for News Feeds. It has the following options:

Help25-plugin manager-edit-newsfeeds-options-screen.png

  • Search Limit. The maximum number of search results to return after a search is done.
  • Search Published. Whether or not to include published items in the search results.
  • Search Archived. Whether or not to include archived items in the search results.

Search - Weblinks

This plug-in enables searching for Web Links. It has the following options:

Help25-plugin manager-edit-weblinks-options-screen.png

  • Search Limit. The maximum number of search results to return after a search is done.
  • Search Published. Whether or not to include published items in the search results.
  • Search Archived. Whether or not to include archived items in the search results.

System - Language Filter

This plug-in filters the displayed content depending on language. It should only be enabled when the Language Switcher module is published. This plug-in has no options.

System - Cache

This plug-in enables 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 plug-in has the following options:

Help25-plugin manager-edit-cache-options-screen.png

  • Use Browser Caching. Whether or not to use the mechanism for storing a page cache in the local browser. Default is "No".

System - Debug

This plug-in provides debugging information. The report is shown below the main screen of the front and backend interfaces of your Joomla! installation. It has the following options:

Help25-plugin manager-edit-debug-options-screen.png

  • Allowed Groups. User groups that will see the debug information when enabled.
  • Show Profiling Whether or not to display the profiling waypoints information.
  • Show Queries. Whether or not to include the SQL query log in the debug information.
  • Show Memory Usage. Whether or not to include memory usage data in the debug information.

Language Debug Options:

Help25-plugin manager-edit-debug-language-options-screen.png

  • Show errors when parsing language files. Whether or not to display a list of language files with errors due to their not being in compliance with the Joomla! language file specification.
  • Show Language Files. Whether or not to display the language files that have been loaded to generate the page.
  • Show Language String. Whether or not to include undefined language strings in the debug information.
  • Strip First Word. Whether or not to always strip the first word in multi-word strings.
  • Strip From Start. Strips the specified words from the beginning of the language string. For multiple words separate each word with the pipe ( | ) character like so: word1|word2
  • Strip From End. Strips the specified words from the end of the language string. For multiple words separate each word with the pipe ( | ) character like so: word1|word2

System - Log

This plug-in enables system logging. A log is a file that contains information about the web site activity. It can be used to see a history of activity and to troubleshoot problems on the site. This plug-in has no options.

System - Redirect

This plug-in enables the Joomla! Redirect system to catch missing pages and redirect users. This plug-in has no options.

System - Remember Me

This plug-in provides "Remember Me" functionality. This allows the website to "remember" your username and password so that you can automatically be logged in when you return to the site. This plug-in has no options.

System - SEF

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

User - Profile

This plug-in adds user profile capability to your website. Website users will be able to fill out profile fields that you enable in the options section of this plug-in. You can control what profile fields are shown in the new user registration form and/or each user's editable profile screen. To control what fields are shown in the new user registration form, set the field options in the section labeled User profile information required at registration. For profile fields shown in the user's profile screen which it editable after login, set the field option in the options section labeled Required user profile information. For each field you have the following options:

  • Required. The field is visible in user profiles and users are required to fill it out.
  • Optional. The field is visible in user profiles but is optional and users do not need to fill it out.
  • Disabled. The field is disabled and not visible in user profiles.

Help25-plugin manager-edit-profile-options-screen.png

  • All fields are text fields with the exception of the Terms of Service field. The Terms of Service field is a radio button that the user can click on to signify their agreement with the website's terms of service.

User - Contact Creator

This plug-in automatically creates contact information for new users. It has the following options:

Help25-plugin manager-edit-contact creator-options-screen.png

  • Automatic Webpage. A formatted string to automatically generate a contact's web page. [name] is replaced with the name, [username] is replaced with the username, [userid] is replaced with the user ID and [email] is replaced with the email.
  • Category. Category to assign contacts to by default.
  • Autopublish the contact. Optionally have the automatically created contact set to the published state and visible to your website visitors.

User - Joomla!

This plug-in handles the default user synchronization. It has the following options:

Help25-plugin manager-edit-joomla-options-screen.png

  • Auto-create Users. Whether or not to automatically create registered Joomla! users where possible. Default is "Yes".

Quick Tips

  • If you are using the TinyMCE editor, you can control which options appear on the editor's toolbar by setting the parameters in the "Editor - TinyMCE" plug-in.
  • Starting with Joomla! 1.6, configurable plug-in settings are referred to as 'options'. In previous versions of Joomla! these configurable settings were referred to as 'parameters'. You may see the terms 'options' and 'parameters' used interchangeably in help documentation and tutorials you encounter.

Related Information