CKEditor 3.x/Developers Guide/Installation - Revision history

Anna: Typo corrected

2012-01-18T08:18:53Z

Typo corrected

Anna: /* Upgrade */ Typo corrected (thanks, Jeff!)

2011-05-17T11:09:46Z

‎Upgrade: Typo corrected (thanks, Jeff!)

Saare: Removed duplicated line

2011-02-27T16:55:09Z

Removed duplicated line

Anna: Minimum Setup section moved to a separate article

2011-01-04T12:58:38Z

Minimum Setup section moved to a separate article

Anna: /* Minimum Setup */ Typo

2011-01-04T10:28:20Z

‎Minimum Setup: Typo

Anna: Minimum Setup section added

2011-01-04T10:18:36Z

Minimum Setup section added

Anna: Article contents proof-read and formatted

2011-01-04T08:34:01Z

Article contents proof-read and formatted

Garryyao: Add upgrade installation instructions.

2010-12-01T05:36:56Z

Add upgrade installation instructions.

Wiktor: Fixed typo

2009-01-28T11:58:19Z

Fixed typo

Fredck: New page: Installing CKEditor is a easy task. Just follow these simple steps: #'''Download''' the latest version of the editor from our web site: http://ckeditor.com/ #'''Extract''' (decompress) ...

2009-01-27T23:48:33Z

New page: Installing CKEditor is a easy task. Just follow these simple steps: #'''Download''' the latest version of the editor from our web site: http://ckeditor.com/ #'''Extract''' (decompress) ...

New page

Installing CKEditor is a easy task. Just follow these simple steps:

#'''Download''' the latest version of the editor from our web site: http://ckeditor.com/
#'''Extract''' (decompress) the downloaded file to a directory called "ckeditor" in the root of your web site.

'''Note:''' You can place the files in whichever path at your web site. "ckeditor" is the default one.

== Checking Your Installation ==

The editor comes with a few sample pages that can be used to verify that installation proceeded properly. Take a look at the _samples directory.

To test your installation just call the following page at your web site:
<pre>http://<your site>/<FCKeditor installation path>/_samples/index.html

For example:
http://www.example.com/ckeditor/_samples/index.html
</pre>

@@ Line 34: / Line 34: @@
 <code><nowiki>http://www.example.com/ckeditor/_samples/index.html</nowiki></code>
-== Mimimum Setup ==
+== Minimum Setup ==
 If you would like to tailor your CKEditor installation to your own needs, stripping some of the files that you are not going to use, refer to the [[CKEditor 3.x/Developers Guide/Minimum Setup|Minimum Setup]] section of the Developer's Guide.

@@ Line 20: / Line 20: @@
 # '''Copy''' all configuration files that '''you have changed''' from the backup folder to their corresponding position in the new directory. These could include (but do not have to be limited to) the following files:
 #* <code>config.js</code>
-#* <code>content.css</code>
+#* <code>contents.css</code>
 #* <code>plugins/templates/templates/default.js</code>
 #* <code>plugins/styles/styles/default.js</code>

@@ Line 22: / Line 22: @@
 #* <code>content.css</code>
 #* <code>plugins/templates/templates/default.js</code>
 #* <code>plugins/styles/styles/default.js</code>
 #* <code>plugins/pastefromword/filter/default.js</code>

@@ Line 35: / Line 35: @@
 <code><nowiki>http://www.example.com/ckeditor/_samples/index.html</nowiki></code>
-== Minimum Setup ==
+== Mimimum Setup ==
-You probably do not need to use all of the files from the CKEditor installation package on a production server, so you can go through the list below and manually remove some of them according to your needs.
+If you would like to tailor your CKEditor installation to your own needs, stripping some of the files that you are not going to use, refer to the [[CKEditor 3.x/Developers Guide/Minimum Setup|Minimum Setup]] section of the Developer's Guide.

@@ Line 37: / Line 37: @@
 == Minimum Setup ==
 You probably do not need to use all of the files from the CKEditor installation package on a production server, so 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>_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.
+* <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>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.

← Older revision		Revision as of 10:18, 4 January 2011
Line 34:		Line 34:
	For example:<br />		For example:<br />
	<code><nowiki>http://www.example.com/ckeditor/_samples/index.html</nowiki></code>		<code><nowiki>http://www.example.com/ckeditor/_samples/index.html</nowiki></code>
		+
		+	== Minimum Setup ==
		+	You probably do not need to use all of the files from the CKEditor installation package on a production server, so 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 1: / Line 1: @@
-Installing CKEditor is a easy task. Just follow these simple steps:
+__TOC__
-== Installation procedures ==
+== Installation Procedures ==
-=== Fresh installation ===
+=== Fresh Installation ===
-#'''Download''' the latest version of the editor from our web site: http://ckeditor.com/
+To install CKEditor for the first time, proceed in the following way:
-#'''Extract''' (decompress) the downloaded file to a directory called "ckeditor" in the root of your web site
+# '''Download''' the latest version of the editor from our website: http://ckeditor.com/download
-'''Note:''' You can place the files in whichever path at your web site. "ckeditor" is the default one.
+# '''Extract''' (decompress) the downloaded archive to a directory called <code>ckeditor</code> in the root of your website.
-=== Upgrade installation ===
+<note>You can place the files in any path of your website. The <code>ckeditor</code> directory is the default one.
-# Rename your old editor folder to a backup, as e.g. "ckeditor_old"
+</note>
-The editor comes with a few sample pages that can be used to verify that installation proceeded properly. Take a look at the _samples directory.
+=== Upgrade ===
-To test your installation just call the following page at your web site:
+== Verification of the Installation ==
-<pre>http://&lt;your site&gt;/&lt;CKEditor installation path&gt;/_samples/index.html
+CKEditor comes with a few sample pages that can be used to verify that installation proceeded properly. In order to see whether the editor is working, take a look at the <code>_samples</code> directory.
-For example:
+To test your installation, call the following page at your website:<br />
-http://www.example.com/ckeditor/_samples/index.html
+<code><nowiki>http://<</nowiki><em>your site</em><nowiki>>/<</nowiki><em>CKEditor installation path</em><nowiki>>/_samples/index.html</nowiki></code>
-</pre>