(Created page with 'As defined at the Integration page, it's enough to include the "ckeditor.js" file into your pages to have CKEditor working. There ar…') |
(Article contents proof-read and formatted) |
||
| Line 1: | Line 1: | ||
| − | As | + | As described in the [[CKEditor_3.x/Developers_Guide/Integration|Integration]] article, to make CKEditor work it is enough to include the <code>ckeditor.js</code> file in your pages. However, there are some situations when the original editor file name may not be used: |
| − | |||
* The file must be renamed, for any reason. | * The file must be renamed, for any reason. | ||
| − | * The original editor script is merged with other scripts used in the page, to reduce the number of files being downloaded. This single file will also have a name that | + | * The original editor script is merged with other scripts used in the page, to reduce the number of files being downloaded. This single file will also have a name that is different from <code>ckeditor.js</code>. This is the most common case. |
| − | * You have yet another file named | + | * You have yet another file named <code>ckeditor.js</code> which is not placed in the editor installation directory. |
== The Problem == | == The Problem == | ||
| + | In order to work correctly CKEditor needs to know where in the website it is installed. Thanks to that information the editor is able to load other resource files like skins, language files, plugins, etc. In other words, the editor installation path is needed. | ||
| − | + | By default, CKEditor is looking for the <code>ckeditor.js</code> file in the <code><script></code> tags present in the page in order to automatically retrieve its installation path. If it is not able to find it, just like in the cases presented above, the editor will simply not work. | |
| − | |||
| − | By default, CKEditor | ||
== The Solution: CKEDITOR_BASEPATH == | == The Solution: CKEDITOR_BASEPATH == | ||
| + | When loading the editor script, CKEditor is looking for the global <code>CKEDITOR_BASEPATH</code> JavaScript variable that contains the editor installation path. If it is defined, its value is used. Otherwise the automatic detection process described above takes place. In order to solve this uncommon loading issue it is thus enough to define the <code>CKEDITOR_BASEPATH</code> variable. For example: | ||
| − | + | <source lang="javascript"> | |
| − | |||
| − | |||
<script type="text/javascript"> | <script type="text/javascript"> | ||
var CKEDITOR_BASEPATH = '/ckeditor/'; | var CKEDITOR_BASEPATH = '/ckeditor/'; | ||
</script> | </script> | ||
| + | |||
<script src="all_my_scripts.js" type="text/javascript"></script> | <script src="all_my_scripts.js" type="text/javascript"></script> | ||
| − | </ | + | </source> |
| − | Note that this global JavaScript variable must be set '''before''' you include the CKEditor code. In the above | + | Note that this global JavaScript variable must be set '''''before''''' you include the CKEditor code. In the example above the variable definition was placed in-page, but it could also be included inside the <code>all_my_scripts.js</code> file, at the start of it (or in any case — before the editor code). |
Latest revision as of 20:17, 29 August 2011
As described in the Integration article, to make CKEditor work it is enough to include the ckeditor.js file in your pages. However, there are some situations when the original editor file name may not be used:
- The file must be renamed, for any reason.
- The original editor script is merged with other scripts used in the page, to reduce the number of files being downloaded. This single file will also have a name that is different from
ckeditor.js. This is the most common case. - You have yet another file named
ckeditor.jswhich is not placed in the editor installation directory.
The Problem
In order to work correctly CKEditor needs to know where in the website it is installed. Thanks to that information the editor is able to load other resource files like skins, language files, plugins, etc. In other words, the editor installation path is needed.
By default, CKEditor is looking for the ckeditor.js file in the <script> tags present in the page in order to automatically retrieve its installation path. If it is not able to find it, just like in the cases presented above, the editor will simply not work.
The Solution: CKEDITOR_BASEPATH
When loading the editor script, CKEditor is looking for the global CKEDITOR_BASEPATH JavaScript variable that contains the editor installation path. If it is defined, its value is used. Otherwise the automatic detection process described above takes place. In order to solve this uncommon loading issue it is thus enough to define the CKEDITOR_BASEPATH variable. For example:
<script type="text/javascript"> var CKEDITOR_BASEPATH = '/ckeditor/'; </script> <script src="all_my_scripts.js" type="text/javascript"></script>
Note that this global JavaScript variable must be set before you include the CKEditor code. In the example above the variable definition was placed in-page, but it could also be included inside the all_my_scripts.js file, at the start of it (or in any case — before the editor code).