Actions

Help16

Difference between revisions of "Extensions Plugin Manager Edit"

From Joomla! Documentation

m (Editor - TinyMCE)
Line 151: Line 151:
  
 
===Editor - TinyMCE===
 
===Editor - TinyMCE===
This plug-in loads the TinyMCE editor. This is the default editor in Joomla!.  
+
This plug-in loads the TinyMCE editor. This is the default editor in Joomla!.
 +
 
[[Image:Plugin.Tinymce_Output.png]]
 
[[Image:Plugin.Tinymce_Output.png]]
  

Revision as of 15:09, 5 September 2010

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

Help16-plugin manager-edit-screen.png

Details

The Details section is the same for all Plug-ins, as follows:

  • 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 can not 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.

Basic Options

If present, the Basic Options section contains any additional configuration options available for the plug-in.

Advanced Options

If present, the Advanced Options section provides additional advanced configuration options which allow you to further customize the plug-in.

Toolbar

At the top right you will see the toolbar:

Help16-plugin manager-edit-toolbar.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.
  • 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.
  • 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:

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

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

Help16-plugin manager-edit-openid-options-screen.png

  • Convert Old Usernames.
  • Require Policy phishing-resistant.
  • Require Policy multi-factor.
  • Require Policy multi-factor-physical.

Content - Email Cloaking

This Plugin 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 Plugin.

Email Cloaking has the following options:

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

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

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

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

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

Help16-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.
  • 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 plug-in has the following advanced options:

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

  • Toolbar. Whether show the toolbar above or below the editor window.

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

  • Horizontal Rule. Hide or Show the 'Horizontal Rule' button.
  • Smilies. Hide or Show the 'Smilies' button.
  • Table. Hide or Show the Table buttons.
  • Style. Hide or Show the 'CSS Style' button.
  • Layer. Hide or Show the Layer buttons.
  • XHTMLxtras. Hide or Show the additional XHTML features.
  • Template. Hide or Show the 'Template' button.
  • Directionality. Hide or Show the 'Directionality' button.
  • Fullscreen. 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. Hide or Show the 'Preview' button.
  • Element Path. If set to "On", show the 'Set Classes' button for the marked text.
  • 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.

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 Plugin enables searching for Category information. 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 searching for Contacts. 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 - Content

This Plugin enables searching for Articles. 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 - Newsfeeds

This Plugin enables searching for News Feeds. 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 - Weblinks

This Plugin enables searching for Web Links. 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. The report is shown below the mainscreen (front- & backend). It has the following parameters:

Plugin.Debug Params.png

  • Display Profiling Information Whether or not to display the time profiling information.
  • 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.
  • Display loaded language files Whether or not to display the language files that have been loaded to generate the page. This has two modes: diagnostic and designer. Diagnostic mode displays the untranslated string and the likely file location whether the JText call was made. Designer mode displays the strings in a format that can be copy-pasted into a .ini language file (displays the list in KEY=String format).
  • Strip Key Prefix When untranslated strings are displayed in Designer mode, this allows you to strip a prefix from the string to form the key. This is useful if the designer uses a common prefix for their extension(s) when using JText methods.

Note that the display of untranslated strings will only display the value passed to the appropriate JText method. For example, with the following code:

<?php echo JText::_( 'Reports Import Configuration' ); ?>

If untranslated, Designer mode will display this as:

# /administrator/components/com_reports/views/reports/tmpl/default.php
REPORTS IMPORT CONFIGURATION=Reports Import Configuration

If the Strip Key Prefix is set to "Reports", then the display would change slightly to:

# /administrator/components/com_reports/views/reports/tmpl/default.php
REPORTS IMPORT CONFIGURATION=Import Configuration

Finally, the path shown is only a best guess based on a call to the PHP debug_backtrace function. Sometimes it is accurate, sometimes it is not and there are also cases where no file could be determined. In those cases you have to use your best judgement.

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

Plugin legacy parameters.png

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

System - Cache

This Plugin 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 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 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 Plugin has no parameters.

System - Remember Me

This Plugin 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 plugin has no parameters.

System - Backlink

The Backlink Plugin provides support for legacy Joomla! 1.0.x links. It redirects old style URL and document links to the correct Joomla! 1.5 targets. It has the following parameters:

Plugin backlink parameters.png

  • Search Query Strings. If "Yes", the system will search for version 1.0 query strings that might match and then redirects to the new URL. Default is "Yes".
  • Search SEF. If "Yes", the system will use the Joomla! 1.0 style SEF format and will redirect to the new link. Default is "Yes".
  • Attempt Legacy SEF. If "Yes", the system will use the Joomla! 1.0 style of SEF format and will attempt to generate a valid link. Default is "Yes".

User - Joomla!

This Plugin handles the default User synchronisation. It has the following paramemters:

Plugin user joomla parameters.png

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

XML-RPC - Joomla

This Plugin provides the XML-RPC API to Joomla! users. It has no parameters.

XML-RPC - Blogger API

This Plugin enables the Blogger XML-RPC API protocol for your Joomla! web site. If enabled, this allows bloggers to add Articles to the site from any application that supports this API. This Plugin has the following parameters:

Plugin xmlrpc parameters.png

  • New posts. The Category in which to place new posts received via this API. Select from the drop-down list of Categories.
  • Edit posts. The Section from which to retrieve new posts from. Select from the drop-down list of Sections.

Quick Tips

  • If you are using the TinyMCE 2.0 editor, you can control which options appear on the editor's toolbar by setting the parameters in the "Editor - TinyMCE 2.0" Plugin.
  • 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