CKEditor 3.x/Developers Guide/Minimum Setup - Revision history

Anna at 10:57, 30 April 2012

2012-04-30T10:57:48Z

Anna: Missing code tags added

2012-04-30T10:55:21Z

Missing code tags added

Anna: Dashes changed

2012-04-30T10:39:07Z

Dashes changed

Anna: Minor rewording

2012-04-30T09:10:40Z

Minor rewording

Anna: Minor adjustment

2012-04-30T09:09:57Z

Minor adjustment

Anna: Minor corrections

2011-01-04T13:20:01Z

Minor corrections

Anna: Minimum Setup article added

2011-01-04T12:58:18Z

Minimum Setup article added

New page

CKEditor is highly customizable and can be adjusted to your needs. In order to make your customization efforts easier, below you will find a summary of the contents of CKEditor installation package. This should help you minimize the number of files deployed to the production server in case you wanted to only use the bare minimum that can make CKEditor work. If needed, you can go through the list below and manually remove some of them according to your needs.
* <code>_samples</code> — this directory contains CKEditor samples. Using the sample files is the easiest way to verify whether your setup works properly. If CKEditor works correctly, you can safely remove the whole <code>_ samples</code> folder.
* <code>_source</code> — this directory contains CKEditor source code. It is needed only if you intend to use the <code>ckeditor_source.js</code> script and load CKEditor from source files.
* <code>adapters</code> — this directory contains CKEditor adapters. It may be removed if you do not use any adapters, like the [[CKEditor 3.x/Developers Guide/jQuery Adapter|jQuery]] one.
* <code>images</code> — this directory contains CKEditor graphics files. It is necessary for CKEditor to work.
* <code>lang</code> — this directory contains CKEditor language files. It is necessary for CKEditor to work, although you can remove the unused language files if you force the CKEditor interface language using the <code>[http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html#.language CKEDITOR.config.language]</code> property set in the <code>config.js</code> file or limit the number of languages available using the <code>[http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.lang.html#.languages CKEDITOR.lang.languages]</code> setting from the <code>core/lang.js</code> file.
* <code>plugins</code> — this directory contains the plugin files and is necessary for CKEditor to work. Due to the modular construction of the editor some core functionality was delegated to plugins. You can remove some unused plugins that are not packed in <code>ckeditor.js</code> (and thus listed in the <code>ckeditor.pack</code> file) and are only loaded on demand through the [http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html#.extraPlugins CKEDITOR.config.extraPlugins] property.
* <code>skins</code> — this directory contains CKEditor skin files along with toolbar buttons and stylesheet definitions and is necessary for CKEditor to work. You can however remove unused skins and their files.
* <code>themes</code> — is necessary for CKEditor to work.

From the CKEditor root directory you can safely remove the following files:
* <code>CHANGES.html</code>
* All <code>.asp</code> files.
* All <code>.php</code> files.
* <code>ckeditor.pack</code>
* <code>ckeditor_basic.js</code> and <code>ckeditor_basic_source.js</code> files (if you do not use this method for loading CKEditor)
* <code>ckeditor_source.js</code> (if you do not use this method for loading CKEditor)
* <code>INSTALL.html</code>

@@ Line 8: / Line 8: @@
 * <code>skins</code> &ndash; this directory contains CKEditor skin files along with toolbar buttons and stylesheet definitions and is necessary for CKEditor to work. You can however remove unused skins and their files.
 * <code>themes</code> &ndash; is necessary for CKEditor to work.
 From the CKEditor root directory you can safely remove the following files:

@@ Line 5: / Line 5: @@
 * <code>images</code> &ndash; this directory contains CKEditor graphics files. It is necessary for CKEditor to work.
 * <code>lang</code> &ndash; this directory contains CKEditor language files. It is necessary for CKEditor to work, although you can remove the unused language files if you force the CKEditor interface language using the <code>[http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html#.language CKEDITOR.config.language]</code> property set in the <code>config.js</code> file.
-* <code>plugins</code> &ndash; this directory contains the plugin files and is necessary for CKEditor to work. Due to the modular construction of the editor some core functionality was delegated to plugins. You can remove some unused plugins that are not packed in <code>ckeditor.js</code> (and thus listed in the <code>ckeditor.pack</code> file) and are only loaded on demand through the [http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html#.extraPlugins CKEDITOR.config.extraPlugins] property.
+* <code>plugins</code> &ndash; this directory contains the plugin files and is necessary for CKEditor to work. Due to the modular construction of the editor some core functionality was delegated to plugins. You can remove some unused plugins that are not packed in <code>ckeditor.js</code> (and thus listed in the <code>ckeditor.pack</code> file) and are only loaded on demand through the <code>[http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html#.extraPlugins CKEDITOR.config.extraPlugins]</code> property.
 * <code>skins</code> &ndash; this directory contains CKEditor skin files along with toolbar buttons and stylesheet definitions and is necessary for CKEditor to work. You can however remove unused skins and their files.
 * <code>themes</code> &ndash; is necessary for CKEditor to work.

@@ Line 1: / Line 1: @@
 CKEditor is highly customizable and can be adjusted to your needs. In order to make your customization efforts easier, below you will find a summary of the contents of the CKEditor installation package. This should help you minimize the number of files deployed to the production server in case you wanted to only use the bare minimum that can make CKEditor work. If needed, you can go through the file list below and manually remove some of them according to your needs.
-* <code>_samples</code> &mdash; this directory contains CKEditor samples. Using the sample files is the easiest way to verify whether your setup works properly. If CKEditor works correctly, you can safely remove the whole <code>_ samples</code> folder.
+* <code>_samples</code> &ndash; this directory contains CKEditor samples. Using the sample files is the easiest way to verify whether your setup works properly. If CKEditor works correctly, you can safely remove the whole <code>_ samples</code> folder.
-* <code>_source</code> &mdash; this directory contains CKEditor source code. It is needed only if you intend to use the <code>ckeditor_source.js</code> script and load CKEditor from source files.
+* <code>_source</code> &ndash; this directory contains CKEditor source code. It is needed only if you intend to use the <code>ckeditor_source.js</code> script and load CKEditor from source files.
-* <code>adapters</code> &mdash; this directory contains CKEditor adapters. It may be removed if you do not use any adapters, like the [[CKEditor 3.x/Developers Guide/jQuery Adapter|jQuery]] one.
+* <code>adapters</code> &ndash; this directory contains CKEditor adapters. It may be removed if you do not use any adapters, like the [[CKEditor 3.x/Developers Guide/jQuery Adapter|jQuery]] one.
-* <code>images</code> &mdash; this directory contains CKEditor graphics files. It is necessary for CKEditor to work.
+* <code>images</code> &ndash; this directory contains CKEditor graphics files. It is necessary for CKEditor to work.
-* <code>lang</code> &mdash; this directory contains CKEditor language files. It is necessary for CKEditor to work, although you can remove the unused language files if you force the CKEditor interface language using the <code>[http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html#.language CKEDITOR.config.language]</code> property set in the <code>config.js</code> file.
+* <code>lang</code> &ndash; this directory contains CKEditor language files. It is necessary for CKEditor to work, although you can remove the unused language files if you force the CKEditor interface language using the <code>[http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html#.language CKEDITOR.config.language]</code> property set in the <code>config.js</code> file.
-* <code>plugins</code> &mdash; this directory contains the plugin files and is necessary for CKEditor to work. Due to the modular construction of the editor some core functionality was delegated to plugins. You can remove some unused plugins that are not packed in <code>ckeditor.js</code> (and thus listed in the <code>ckeditor.pack</code> file) and are only loaded on demand through the [http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html#.extraPlugins CKEDITOR.config.extraPlugins] property.
+* <code>plugins</code> &ndash; this directory contains the plugin files and is necessary for CKEditor to work. Due to the modular construction of the editor some core functionality was delegated to plugins. You can remove some unused plugins that are not packed in <code>ckeditor.js</code> (and thus listed in the <code>ckeditor.pack</code> file) and are only loaded on demand through the [http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html#.extraPlugins CKEDITOR.config.extraPlugins] property.
-* <code>skins</code> &mdash; this directory contains CKEditor skin files along with toolbar buttons and stylesheet definitions and is necessary for CKEditor to work. You can however remove unused skins and their files.
+* <code>skins</code> &ndash; this directory contains CKEditor skin files along with toolbar buttons and stylesheet definitions and is necessary for CKEditor to work. You can however remove unused skins and their files.
-* <code>themes</code> &mdash; is necessary for CKEditor to work.
+* <code>themes</code> &ndash; is necessary for CKEditor to work.
 From the CKEditor root directory you can safely remove the following files:

@@ Line 1: / Line 1: @@
-CKEditor is highly customizable and can be adjusted to your needs. In order to make your customization efforts easier, below you will find a summary of the contents of the CKEditor installation package. This should help you minimize the number of files deployed to the production server in case you wanted to only use the bare minimum that can make CKEditor work. If needed, you can go through the list below and manually remove some of them according to your needs.
+CKEditor is highly customizable and can be adjusted to your needs. In order to make your customization efforts easier, below you will find a summary of the contents of the CKEditor installation package. This should help you minimize the number of files deployed to the production server in case you wanted to only use the bare minimum that can make CKEditor work. If needed, you can go through the file list below and manually remove some of them according to your needs.
 * <code>_samples</code> &mdash; this directory contains CKEditor samples. Using the sample files is the easiest way to verify whether your setup works properly. If CKEditor works correctly, you can safely remove the whole <code>_ samples</code> folder.
 * <code>_source</code> &mdash; this directory contains CKEditor source code. It is needed only if you intend to use the <code>ckeditor_source.js</code> script and load CKEditor from source files.

@@ Line 1: / Line 1: @@
-CKEditor is highly customizable and can be adjusted to your needs. In order to make your customization efforts easier, below you will find a summary of the contents of CKEditor installation package. This should help you minimize the number of files deployed to the production server in case you wanted to only use the bare minimum that can make CKEditor work. If needed, you can go through the list below and manually remove some of them according to your needs.
+CKEditor is highly customizable and can be adjusted to your needs. In order to make your customization efforts easier, below you will find a summary of the contents of the CKEditor installation package. This should help you minimize the number of files deployed to the production server in case you wanted to only use the bare minimum that can make CKEditor work. If needed, you can go through the list below and manually remove some of them according to your needs.
 * <code>_samples</code> &mdash; this directory contains CKEditor samples. Using the sample files is the easiest way to verify whether your setup works properly. If CKEditor works correctly, you can safely remove the whole <code>_ samples</code> folder.
 * <code>_source</code> &mdash; this directory contains CKEditor source code. It is needed only if you intend to use the <code>ckeditor_source.js</code> script and load CKEditor from source files.

@@ Line 4: / Line 4: @@
 * <code>adapters</code> &mdash; this directory contains CKEditor adapters. It may be removed if you do not use any adapters, like the [[CKEditor 3.x/Developers Guide/jQuery Adapter|jQuery]] one.
 * <code>images</code> &mdash; this directory contains CKEditor graphics files. It is necessary for CKEditor to work.
-* <code>lang</code> &mdash; this directory contains CKEditor language files. It is necessary for CKEditor to work, although you can remove the unused language files if you force the CKEditor interface language using the <code>[http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html#.language CKEDITOR.config.language]</code> property set in the <code>config.js</code> file or limit the number of languages available using the <code>[http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.lang.html#.languages CKEDITOR.lang.languages]</code> setting from the <code>core/lang.js</code> file.
+* <code>lang</code> &mdash; this directory contains CKEditor language files. It is necessary for CKEditor to work, although you can remove the unused language files if you force the CKEditor interface language using the <code>[http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html#.language CKEDITOR.config.language]</code> property set in the <code>config.js</code> file.
 * <code>plugins</code> &mdash; this directory contains the plugin files and is necessary for CKEditor to work. Due to the modular construction of the editor some core functionality was delegated to plugins. You can remove some unused plugins that are not packed in <code>ckeditor.js</code> (and thus listed in the <code>ckeditor.pack</code> file) and are only loaded on demand through the [http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html#.extraPlugins CKEDITOR.config.extraPlugins] property.
 * <code>skins</code> &mdash; this directory contains CKEditor skin files along with toolbar buttons and stylesheet definitions and is necessary for CKEditor to work. You can however remove unused skins and their files.
@@ Line 11: / Line 11: @@
 From the CKEditor root directory you can safely remove the following files:
 * <code>CHANGES.html</code>
-* All <code>.asp</code> files.
+* All <code>.asp</code> files  (if you do not use ASP integration)
-* All <code>.php</code> files.
+* All <code>.php</code> files (if you do not use PHP integration)
 * <code>ckeditor.pack</code>
 * <code>ckeditor_basic.js</code>  and <code>ckeditor_basic_source.js</code> files (if you do not use this method for loading CKEditor)
 * <code>ckeditor_source.js</code> (if you do not use this method for loading CKEditor)
 * <code>INSTALL.html</code>