Actions

Help15

Difference between revisions of "Screen.plugins.edit.15"

From Joomla! Documentation

(Editor - TinyMCE 2.0)
m (Related Information: category reorganizing)
 
(12 intermediate revisions by 3 users not shown)
Line 78: Line 78:
 
===Content - Code Hightlighter (GeSHi)===
 
===Content - Code Hightlighter (GeSHi)===
 
This Plugin displays formatted code in Articles based on the GeSHi highlighting engine. It has no parameters.
 
This Plugin displays formatted code in Articles based on the GeSHi highlighting engine. It has no parameters.
 +
<pre>
 +
Syntax usage :
 +
&lt;pre xml:lang="php"&gt;
 +
echo $test;
 +
&lt;/pre&gt;
 +
</pre>
  
 
===Content - Load Module===
 
===Content - Load Module===
Line 113: Line 119:
  
 
This Plugin has the following Plugin parameters:
 
This Plugin has the following Plugin parameters:
 +
 
[[Image:Plugin_tinymce_parameters.png]]
 
[[Image: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.
 
*'''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.
Line 133: Line 140:
  
 
[[Image:Plugin_tinymce_advanced.png]]
 
[[Image:Plugin_tinymce_advanced.png]]
*'''Horizontal Rule.''' Whether to Hide or Show the Horizontal Rule button.
+
*'''Toolbar.''' Whether show the toolbar above or below the editor window.
  
 
The following settings only apply if the editor is in Advanced mode.
 
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.
 
*'''Smilies.''' Hide or Show the 'Smilies' button.
 
*'''Table.''' Hide or Show the Table buttons.
 
*'''Table.''' Hide or Show the Table buttons.
Line 152: Line 160:
 
*'''Date Format.''' The Date format to use for Insert Date.
 
*'''Date Format.''' The Date format to use for Insert Date.
 
*'''Insert Time.''' Hide or Show the 'Insert Time' button.
 
*'''Insert Time.''' Hide or Show the 'Insert Time' button.
*'''Date Format.''' The Time format to use for Insert Time.
+
*'''Time Format.''' The Time format to use for Insert Time.
  
 
===Editor - XStandard Lite 2.0===
 
===Editor - XStandard Lite 2.0===
This Plugin provides the XStandard editor. It has the following parameters:
+
This Plugin provides the XStandard editor.  
 +
 
 +
''Note'': after enabling this plugin, the editor itself must be downloaded and installed from the XStandard Website http://xstandard.com/
 +
 
 +
[[Image:Plugin.Xstandardlite_Output.png]]
 +
 
 +
It has the following parameters:
  
 
[[Image:Plugin_xstandard_parameters.png]]
 
[[Image:Plugin_xstandard_parameters.png]]
Line 213: Line 227:
  
 
===System - Debug===
 
===System - Debug===
This Plugin provides debugging information. It has the following parameters (note, screenshot needs updating):
+
This Plugin provides debugging information. The report is shown below the mainscreen (front- & backend). It has the following parameters:
  
[[Image:Plugin_debug_parameters.png]]
+
[[Image:Plugin.Debug_Params.png]]
  
*'''Display Profiling Information''' (New in 1.5.4) Whether or not to display the time profiling information.
+
*'''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 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 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 undefined language strings.''' Whether or not to include undefined language strings in the debug information.
*'''Display loaded language files''' (New in 1.5.4) 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).
+
*'''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''' (New in 1.5.4) 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.
+
*'''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:
 
Note that the display of untranslated strings will only display the value passed to the appropriate JText method.  For example, with the following code:
Line 299: Line 313:
 
*To uninstall third-party Plugins: [[screen.installer.15#Plugins Screen|Extension Manager - Plugins Screen]]
 
*To uninstall third-party Plugins: [[screen.installer.15#Plugins Screen|Extension Manager - Plugins Screen]]
  
<noinclude>{{cathelp|1.5|Plugin Manager|Extensions}}</noinclude>
+
<noinclude>{{cathelp|1.5|Plugin Manager Help Screens|Extensions Help Screens}}</noinclude>

Latest revision as of 22:21, 4 August 2012

Contents

How to Access

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

Description

This is where you can edit details and parameters for Plugins. Some Plugins have several parameters, while 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.

To use the GMail plugin:

  • Create a Joomla! User with the same name as a GMail account user.
  • Enable the GMail Plugin.
  • Logout of Joomla!.
  • Login using the GMail username (without "@gmail.com) and the GMail password.

Content - Page Navigation

This Plugin 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 plugin is disabled in this screen, no Page Navigation will show and the parameter settings above will have no effect.

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

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

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!. Plugin.Tinymce Output.png

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

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

Editor - XStandard Lite 2.0

This Plugin provides the XStandard editor.

Note: after enabling this plugin, the editor itself must be downloaded and installed from the XStandard Website http://xstandard.com/

Plugin.Xstandardlite Output.png

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

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 - 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 - Sections

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

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.

Toolbar

At the top right you will see the toolbar:

Plugin edit toolbar.png

  • Save. Save it and return to editing the menu details.
  • Apply. Save it, but stay in the same screen. If you have been working on a screen for a long time and don't want to risk losing your work, pressing Apply saves your work and lets you continue working. If, for example, you lost your Internet connection, your work will be saved up 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.

Quick Tips

  • If you want to use any Extensions in "1.5 Legacy" mode, you need to enable the "System - Legacy" Plugin. This Plugin is disabled by default.
  • 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.

Related Information