CKEditor for Drupal/Plugins - Revision history

Anna: Redirect created

2012-05-31T13:34:31Z

Redirect created

Anna: Article section added

2012-02-27T14:41:35Z

Article section added

Anna: /* Enabling a Plugin */ Formatting added

2012-02-27T14:36:09Z

‎Enabling a Plugin: Formatting added

Anna: Article contents added

2011-10-14T12:04:40Z

Article contents added

New page

{{#CUSTOMTITLE:CKEditor for Drupal Plugins}}

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_plugins_list.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''' > '''Configuration''' >''' Content Authoring''' > '''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 a 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_plugins_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.

← Older revision		Revision as of 13:34, 31 May 2012
Line 1:		Line 1:
−	{{#~~CUSTOMTITLE:CKEditor for Drupal Plugins}}~~	+	#REDIRECT [[CKEditor_for_Drupal/Page_Moved]]
−
−	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_plugins_list.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''' > '''Configuration''' >''' Content Authoring''' > '''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 a 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_plugins_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/~~Plugins#Enabling_a_Plugin\|Enabling a Plugin~~]] ~~section above.~~

← Older revision		Revision as of 14:41, 27 February 2012
Line 25:		Line 25:

	Please note that some plugins require installing additional modules to work correctly.		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/Plugins#Enabling_a_Plugin\|Enabling a Plugin]] section above.

@@ Line 19: / Line 19: @@
 Find a 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.
+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_plugins_button.png|frame|center|New video plugin button appearing on the CKEditor toolbar]]