Template:Drupal Plugins - Revision history

Anna: Link modified

2012-05-31T12:38:55Z

Link modified

Anna: moved Template:Drupal Enterprise Plugins to Template:Drupal Plugins: Same content for OS and Enterprise versions

2012-05-31T12:37:28Z

moved Template:Drupal Enterprise Plugins to Template:Drupal Plugins: Same content for OS and Enterprise versions

Anna: /* Adding a Plugin */ Additional info added

2012-05-31T12:33:56Z

‎Adding a Plugin: Additional info added

Anna: /* Enabling a Plugin */ adding buttons manually described

2012-05-31T12:27:27Z

‎Enabling a Plugin: adding buttons manually described

Anna: TOC added

2012-05-23T13:01:53Z

TOC added

Anna: Template contents added

2012-05-23T12:58:07Z

Template contents added

New page

CKEditor is known for its flexibility and extensibility. New functionality can be added at no cost by using dedicated plugins. Some additional plugins are already included in the module files and can be simply enabled in the Drupal administration panel; others can be installed separately as described below. You can even create your own plugins to further adjust CKEditor for your specific needs.

== Adding a Plugin ==
If you want to add a new CKEditor plugin, download the plugin package that you wish to install and unpack it to the <code>sites\all\modules\ckeditor\plugins</code> directory.

<note>The <code>sites\all\modules\ckeditor\plugins</code> directory is the default one. You can also change it in the '''CKEditor Global Profile''' by adjusting the '''Path to the CKEditor plugins directory''' option.</note>

When the plugin is unpacked correctly, it will automatically appear on the plugins list in your CKEditor profiles along with its toolbar buttons.

[[Image:Drupal__{{{version}}}_Enterprise_add_plugin.png|frame|center|New video plugin appearing on the CKEditor plugins list]]

== Enabling a Plugin ==
If you want to manage CKEditor plugins for a profile, go to the '''Administration panel''' > '''{{{path}}}''' > '''CKEditor''' section. This section lets you choose the plugins relevant for each CKEditor profile from a list. Choose a profile that you want to use and expand the '''Editor appearance''' section of the configuration panel.

Find the plugin in the '''Plugins''' section. In order to activate it, select the checkbox next to its name.

If a plugin contains toolbar buttons, they will be automatically added to the '''All buttons''' toolbar panel. If this is the case, you can add the button to the CKEditor toolbar for a given profile by dragging it to the '''Used buttons''' toolbar panel and dropping in the place where you want it to appear.

[[Image:Drupal_{{{version}}}_Enterprise_add_plugin_button.png|frame|center|New video plugin button appearing on the CKEditor toolbar]]

Please note that some plugins require installing additional modules to work correctly.

== Integrating a Plugin with the CKEditor Module (for Plugin Developers) ==
Integrating your application with the CKEditor module by adding a plugin works through a special hook. An example of the hook is shown below:
<source lang="php">
function MODULENAME_ckeditor_plugin() {
return array(
'plugin_name' => array(
// Plugin name.
'name' => 'plugin_name',
// Plugin description - it will be displayed in the plugins management section of the profile settings.
'desc' => t('Plugin description'),
// The full path to the CKEditor plugin directory, trailing slash included.
'path' => drupal_get_path('module', 'my_module') . '/plugin_dir/',
// Plugin buttons definition (optional).
'buttons' => array(
'button_name' => array('label' => 'Button label', 'icon' => '/path/to/icon/image'),
'button_name' => array('label' => 'Button label', 'icon' => '/path/to/icon/image'),
...
)
)
)
);
}
</source>
Please note that <code>MODULENAME</code> in the code above is the name of the module.

After the hook is used the plugin will automatically appear on the plugin list for each CKEditor profile where you will be able to enable it as described in the [[CKEditor_for_Drupal/Enterprise/Drupal_{{{version}}}/Plugins#Enabling_a_Plugin|Enabling a Plugin]] section above.

← Older revision		Revision as of 12:38, 31 May 2012
Line 52:		Line 52:
	Please note that <code>MODULENAME</code> in the code above is the name of the module.		Please note that <code>MODULENAME</code> in the code above is the name of the module.

−	After the hook is used the plugin will automatically appear on the plugin list for each CKEditor profile where you will be able to enable it as described in the [[CKEditor_for_Drupal/~~Enterprise~~/Drupal_{{{version}}}/Plugins#Enabling_a_Plugin\|Enabling a Plugin]] section above.	+	After the hook is used the plugin will automatically appear on the plugin list for each CKEditor profile where you will be able to enable it as described in the [[CKEditor_for_Drupal/{{{license}}}/Drupal_{{{version}}}/Plugins#Enabling_a_Plugin\|Enabling a Plugin]] section above.

← Older revision		Revision as of 12:27, 31 May 2012
Line 22:		Line 22:
	[[Image:Drupal_{{{version}}}_Enterprise_add_plugin_button.png\|frame\|center\|New video plugin button appearing on the CKEditor toolbar]]		[[Image:Drupal_{{{version}}}_Enterprise_add_plugin_button.png\|frame\|center\|New video plugin button appearing on the CKEditor toolbar]]

		+	Alternatively, if you turned off the toolbar wizard and prefer to enter the toolbar configuration manually, you will need to add the plugin button by yourself by appending it to your toolbar definition code.

	Please note that some plugins require installing additional modules to work correctly.		Please note that some plugins require installing additional modules to work correctly.

← Older revision		Revision as of 13:01, 23 May 2012
Line 1:		Line 1:
		+	__TOC__
	CKEditor is known for its flexibility and extensibility. New functionality can be added at no cost by using dedicated plugins. Some additional plugins are already included in the module files and can be simply enabled in the Drupal administration panel; others can be installed separately as described below. You can even create your own plugins to further adjust CKEditor for your specific needs.		CKEditor is known for its flexibility and extensibility. New functionality can be added at no cost by using dedicated plugins. Some additional plugins are already included in the module files and can be simply enabled in the Drupal administration panel; others can be installed separately as described below. You can even create your own plugins to further adjust CKEditor for your specific needs.

← Older revision	Revision as of 12:37, 31 May 2012
(No difference)

@@ Line 4: / Line 4: @@
 == Adding a Plugin ==
 If you want to add a new CKEditor plugin, download the plugin package that you wish to install and unpack it to the <code>sites\all\modules\ckeditor\plugins</code> directory.
 <note>The <code>sites\all\modules\ckeditor\plugins</code> directory is the default one. You can also change it in the '''CKEditor Global Profile''' by adjusting the '''Path to the CKEditor plugins directory''' option.</note>
@@ Line 11: / Line 13: @@
 [[Image:Drupal__{{{version}}}_Enterprise_add_plugin.png|frame|center|New video plugin appearing on the CKEditor plugins list]]
 == Enabling a Plugin ==