FCKeditor 2.x/Developers Guide/Customization/Plug-ins - Revision history

W.olchawa at 14:07, 17 January 2008

2008-01-17T14:07:18Z

W.olchawa at 14:06, 17 January 2008

2008-01-17T14:06:26Z

W.olchawa at 14:05, 17 January 2008

2008-01-17T14:05:46Z

W.olchawa at 13:59, 17 January 2008

2008-01-17T13:59:13Z

W.olchawa at 13:58, 17 January 2008

2008-01-17T13:58:40Z

W.olchawa at 10:27, 17 January 2008

2008-01-17T10:27:53Z

W.olchawa at 10:23, 17 January 2008

2008-01-17T10:23:01Z

W.olchawa at 10:22, 17 January 2008

2008-01-17T10:22:01Z

W.olchawa at 10:18, 17 January 2008

2008-01-17T10:18:46Z

W.olchawa at 10:16, 17 January 2008

2008-01-17T10:16:16Z

@@ Line 51: / Line 51: @@
 FCKConfig.Plugins.Add( 'tablecommands', null, sOtherPluginPath )&nbsp;;
 FCKConfig.Plugins.Add( 'simplecommands', null, sOtherPluginPath )&nbsp;;</pre>
 == Plugins Recipes ==
@@ Line 59: / Line 58: @@
 * [[FCKeditor 2.x/Developers Guide/Customization/Plug-ins/Popup|Example on how to access the editor from a popup window]]
 * [[FCKeditor 2.x/Developers Guide/Customization/Plug-ins/Context|Example on how to associate a context menu (right click menu) option]]

@@ Line 55: / Line 55: @@
 Here you can find additional configuration methods which allow you to customize the plugins more properly:
 * [[FCKeditor 2.x/Developers Guide/Customization/Plug-ins/Buttons|Establishing a button in the toolbar]]
 * [[FCKeditor 2.x/Developers Guide/Customization/Plug-ins/Popup|Example on how to access the editor from a popup window]]
-* [[FCKeditor 2.x/Developers Guide/Customization/Plug-ins/Context|Example on how to associate a context menu (right click menu)]] option
+* [[FCKeditor 2.x/Developers Guide/Customization/Plug-ins/Context|Example on how to associate a context menu (right click menu) option]]

@@ Line 50: / Line 50: @@
 FCKConfig.Plugins.Add( 'placeholder', 'en,it,de,fr', sOtherPluginPath )&nbsp;;
 FCKConfig.Plugins.Add( 'tablecommands', null, sOtherPluginPath )&nbsp;;
 FCKConfig.Plugins.Add( 'simplecommands', null, sOtherPluginPath )&nbsp;;</pre>
-==== Establishing the button in the toolbar ====
+== Plugins Recipes ==
-You should create a new toolbar in your custom [[FCKeditor 2.x/Developers Guide/Configuration/Configuration File|Configuration File]] to reference the plugin:
+Here you can find additional configuration methods which allow you to customize the plugins more properly:
-<pre>//custom config.js - My custom Configuration File
+* [[FCKeditor 2.x/Developers Guide/Customization/Plug-ins/Buttons|Establishing a button in the toolbar]]
-FCKConfig.ToolbarSets['PluginTest'] = [
+* [[FCKeditor 2.x/Developers Guide/Customization/Plug-ins/Popup|Example on how to access the editor from a popup window]]
-['SourceSimple'],
+* [[FCKeditor 2.x/Developers Guide/Customization/Plug-ins/Context|Example on how to associate a context menu (right click menu)]] option

@@ Line 51: / Line 51: @@
 FCKConfig.Plugins.Add( 'tablecommands', null, sOtherPluginPath )&nbsp;;
 FCKConfig.Plugins.Add( 'simplecommands', null, sOtherPluginPath )&nbsp;;</pre>
 ==== Establishing the button in the toolbar ====

@@ Line 27: / Line 27: @@
 FCKToolbarItems.RegisterItem( 'My_Replace', oReplaceItem )&nbsp;; // 'My_Replace' is the name used in the Toolbar config.
 </pre>
-=== Installing a plugin ===
+=== Installing and adding plugin ===
 To install a new plugin, copy the unzipped plugin to your editor's plugin directory 'editor/plugins' (e.g. for the placeholder plugin the path to its fckplugin.js file would be 'editor/plugins/placeholder/fckplugin.js'). That's all!
 Now to setup the plugin (have it showing up in your editor), follow the next instructions:
@@ Line 48: / Line 69: @@
 </pre>
 In the given example, 'Placeholder', 'My_Find', 'My_replace' and the table commands are implemented by plugins.
 === Plugins Repository ===

@@ Line 26: / Line 26: @@
 FCKToolbarItems.RegisterItem( 'My_Replace', oReplaceItem )&nbsp;; // 'My_Replace' is the name used in the Toolbar config.
 </pre>
 === Installing a plugin ===
@@ Line 39: / Line 38: @@
 <pre>//custom config.js - My custom Configuration File
 FCKConfig.ToolbarSets['PluginTest'] = [
-	['SourceSimple'],
+['SourceSimple'],
-	['My_Find','My_Replace','-','Placeholder'],
+['My_Find','My_Replace','-','Placeholder'],
-	['StyleSimple','FontFormatSimple','FontNameSimple','FontSizeSimple'],
+['StyleSimple','FontFormatSimple','FontNameSimple','FontSizeSimple'],
-	['Table','-','TableInsertRowAfter','TableDeleteRows','TableInsertColumnAfter','TableDeleteColumns','TableInsertCellAfter','TableDeleteCells','TableMergeCells','TableHorizontalSplitCell','TableCellProp'],
+['Table','-','TableInsertRowAfter','TableDeleteRows','TableInsertColumnAfter','TableDeleteColumns','TableInsertCellAfter','TableDeleteCells','TableMergeCells','TableHorizontalSplitCell','TableCellProp'],
-	['Bold','Italic','-','OrderedList','UnorderedList','-','Link','Unlink'],
+['Bold','Italic','-','OrderedList','UnorderedList','-','Link','Unlink'],
-	'/',
+'/',
-	['My_BigStyle','-','Smiley','-','About']
+['My_BigStyle','-','Smiley','-','About']
-] ;
+]&nbsp;;
 </pre>
 In the given example, 'Placeholder', 'My_Find', 'My_replace' and the table commands are implemented by plugins.
 ==== Adding the plugin ====
 You can then add the plugin in your custom [[FCKeditor 2.x/Developers Guide/Configuration/Configuration File|Configuration File]]. You can either change the default path, and add it, or use the third paramter to [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/Plugins.Add|FCKConfig.Plugins.Add]] to specify the path to the plugin:
 <pre>
 // Change the default plugin path.
-FCKConfig.PluginsPath = FCKConfig.BasePath.substr(0, FCKConfig.BasePath.length - 7) + '_samples/_plugins/' ;
+FCKConfig.PluginsPath = FCKConfig.BasePath.substr(0, FCKConfig.BasePath.length - 7) + '_samples/_plugins/'&nbsp;;
 // Add our plugin to the plugins list.
-//		FCKConfig.Plugins.Add( pluginName, availableLanguages )
+// FCKConfig.Plugins.Add( pluginName, availableLanguages )
-//			pluginName: The plugin name. The plugin directory must match this name.
+// pluginName: The plugin name. The plugin directory must match this name.
-//			availableLanguages: a list of available language files for the plugin (separated by a comma).
+// availableLanguages: a list of available language files for the plugin (separated by a comma).
-FCKConfig.Plugins.Add( 'findreplace', 'en,it,fr' ) ;
+FCKConfig.Plugins.Add( 'findreplace', 'en,it,fr' )&nbsp;;
 FCKConfig.Plugins.Add( 'samples' )
 // If you want to use plugins found on other directories, just use the third parameter.
-var sOtherPluginPath = FCKConfig.BasePath.substr(0, FCKConfig.BasePath.length - 7) + 'editor/plugins/' ;
+var sOtherPluginPath = FCKConfig.BasePath.substr(0, FCKConfig.BasePath.length - 7) + 'editor/plugins/'&nbsp;;
-FCKConfig.Plugins.Add( 'placeholder', 'en,it,de,fr', sOtherPluginPath ) ;
+FCKConfig.Plugins.Add( 'placeholder', 'en,it,de,fr', sOtherPluginPath )&nbsp;;
-FCKConfig.Plugins.Add( 'tablecommands', null, sOtherPluginPath ) ;
+FCKConfig.Plugins.Add( 'tablecommands', null, sOtherPluginPath )&nbsp;;
-FCKConfig.Plugins.Add( 'simplecommands', null, sOtherPluginPath ) ;
+FCKConfig.Plugins.Add( 'simplecommands', null, sOtherPluginPath )&nbsp;;</pre>

@@ Line 12: / Line 12: @@
 The '''fckplugin.js''' file defines your plugin. It should register the command(s) that it implements, and create a toolbar button for each one.
 <pre>// Register the related commands.
-FCKCommands.RegisterCommand( 'My_Find'		, new FCKDialogCommand( FCKLang['DlgMyFindTitle']	, FCKLang['DlgMyFindTitle']		, FCKConfig.PluginsPath + 'findreplace/find.html'	, 340, 170 ) ) ;
+FCKCommands.RegisterCommand( 'My_Find' , new FCKDialogCommand( FCKLang['DlgMyFindTitle'] , FCKLang['DlgMyFindTitle'] , FCKConfig.PluginsPath + 'findreplace/find.html' , 340, 170 ) )&nbsp;;
-FCKCommands.RegisterCommand( 'My_Replace'	, new FCKDialogCommand( FCKLang['DlgMyReplaceTitle'], FCKLang['DlgMyReplaceTitle']	, FCKConfig.PluginsPath + 'findreplace/replace.html', 340, 200 ) ) ;
+FCKCommands.RegisterCommand( 'My_Replace' , new FCKDialogCommand( FCKLang['DlgMyReplaceTitle'], FCKLang['DlgMyReplaceTitle'] , FCKConfig.PluginsPath + 'findreplace/replace.html', 340, 200 ) )&nbsp;;
 // Create the "Find" toolbar button.
-var oFindItem		= new FCKToolbarButton( 'My_Find', FCKLang['DlgMyFindTitle'] ) ;
+var oFindItem = new FCKToolbarButton( 'My_Find', FCKLang['DlgMyFindTitle'] )&nbsp;;
-oFindItem.IconPath	= FCKConfig.PluginsPath + 'findreplace/find.gif' ;
+oFindItem.IconPath = FCKConfig.PluginsPath + 'findreplace/find.gif'&nbsp;;
-FCKToolbarItems.RegisterItem( 'My_Find', oFindItem ) ;			// 'My_Find' is the name used in the Toolbar config.
+FCKToolbarItems.RegisterItem( 'My_Find', oFindItem )&nbsp;; // 'My_Find' is the name used in the Toolbar config.
 // Create the "Replace" toolbar button.
-var oReplaceItem		= new FCKToolbarButton( 'My_Replace', FCKLang['DlgMyReplaceTitle'] ) ;
+var oReplaceItem = new FCKToolbarButton( 'My_Replace', FCKLang['DlgMyReplaceTitle'] )&nbsp;;
-oReplaceItem.IconPath	= FCKConfig.PluginsPath + 'findreplace/replace.gif' ;
+oReplaceItem.IconPath = FCKConfig.PluginsPath + 'findreplace/replace.gif'&nbsp;;
-FCKToolbarItems.RegisterItem( 'My_Replace', oReplaceItem ) ;	// 'My_Replace' is the name used in the Toolbar config.
+FCKToolbarItems.RegisterItem( 'My_Replace', oReplaceItem )&nbsp;; // 'My_Replace' is the name used in the Toolbar config.
 </pre>

← Older revision		Revision as of 10:18, 17 January 2008
Line 63:		Line 63:

	You can then add the plugin in your custom [[FCKeditor 2.x/Developers Guide/Configuration/Configuration File\|Configuration File]]. You can either change the default path, and add it, or use the third paramter to [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/Plugins.Add\|FCKConfig.Plugins.Add]] to specify the path to the plugin:		You can then add the plugin in your custom [[FCKeditor 2.x/Developers Guide/Configuration/Configuration File\|Configuration File]]. You can either change the default path, and add it, or use the third paramter to [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/Plugins.Add\|FCKConfig.Plugins.Add]] to specify the path to the plugin:
		+	<pre>
		+
		+	// Change the default plugin path.
		+	FCKConfig.PluginsPath = FCKConfig.BasePath.substr(0, FCKConfig.BasePath.length - 7) + '_samples/_plugins/' ;
		+
		+	// Add our plugin to the plugins list.
		+	// FCKConfig.Plugins.Add( pluginName, availableLanguages )
		+	// pluginName: The plugin name. The plugin directory must match this name.
		+	// availableLanguages: a list of available language files for the plugin (separated by a comma).
		+	FCKConfig.Plugins.Add( 'findreplace', 'en,it,fr' ) ;
		+	FCKConfig.Plugins.Add( 'samples' )
		+
		+	// If you want to use plugins found on other directories, just use the third parameter.
		+	var sOtherPluginPath = FCKConfig.BasePath.substr(0, FCKConfig.BasePath.length - 7) + 'editor/plugins/' ;
		+	FCKConfig.Plugins.Add( 'placeholder', 'en,it,de,fr', sOtherPluginPath ) ;
		+	FCKConfig.Plugins.Add( 'tablecommands', null, sOtherPluginPath ) ;
		+	FCKConfig.Plugins.Add( 'simplecommands', null, sOtherPluginPath ) ;