Skip to content
Snippets Groups Projects

Issue #3322470 by kalash: Replaced readme file.

Open Issue #3322470 by kalash: Replaced readme file.
issue/ckeditor-3322470:3322470-replace-readme.txt-with into 1.0.x
Open kalash jain requested to merge issue/ckeditor-3322470:3322470-replace-readme.txt-with into 1.0.x
Compare
and
1 file
+ 232
− 0
Compare changes
  • Side-by-side
  • Inline
README.md 0 → 100644
+ 232
− 0
# CKEditor 4 - WYSIWYG HTML editor
This module allows Drupal to replace textarea fields with the CKEditor.
This HTML text editor brings many of the powerful functions of known
desktop editors like Word to the web. It's relatively lightweight and
doesn't require any kind of installation on the client computer.
For a full description of the module, visit the
[project page](https://www.drupal.org/project/ckeditor).
Submit bug reports and feature suggestions, or track changes in the
[Issue queue](https://www.drupal.org/project/issues/ckeditor).
## Table of contents
- Requirements
- Installation / Configuration
- Installation troubleshooting
- Plugins: Teaser break and Pagebreak
- Uploading images and files
- How to install CKFinder
- Upgrading instructions
- Maintainers
## Requirements
- Drupal 6.x
- PHP 4.3.0 or greater
- CKEditor 3.0.2 or greater (<http://ckeditor.com/>)
## Installation / Configuration
Note: this instruction assumes that you install CKEditor in
sites/all/modules directory (recommended).
1. Unzip the files in the sites/all/modules directory. It should now
contain a ckeditor directory.
2. Download CKEditor from <http://ckeditor.com/download>. Unzip the
contents of the ckeditor directory in the
sites/all/modules/ckeditor/ckeditor directory.
Note: you can skip uploading "_samples" and "_source" folders.
3. Enable the module as usual from Drupal's admin pages.
4. Grant permissions for use of CKEditor in
"Administer > User Management > Permissions"
Note: to enable the file browser, read also the
"How to enable the file browser" section.
5. Under "Administer > Site configuration > CKEditor", adjust
the ckeditor profiles. In each profile you can choose which textareas
will be replaced by CKEditor, select default toolbar and configure
some more advanced settings.
6. For the Rich Text Editing to work you also need to configure your filters
for the users that may access Rich Text Editing.
Either grant those users Full HTML access or use the HTML tags
7. To have a better control over line breaks, you may disable Line break converter
in the chosen filter (recommended).
8. Modify the ckeditor.config.js file to custom your needs (optional).
Configuration options are available here:
<http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html>
Developers documentation for CKEditor:
<http://docs.cksource.com/CKEditor_3.x/Developers_Guide>
In ckeditor.config.js you may define your own toolbars with selected buttons.
WARNING: clear browser's cache after you modify any of the javascript files.
If you don't do this, you may notice that browser is ignoring all your changes.
## Installation troubleshooting
If your CKEditor does not show you must check if all files are
extracted correctly.
The directory /modules/ckeditor/ckeditor/ should have the following files:
ckeditor.js, config.js, contents.css
and directories: "skins", "themes", "lang", "images"
The correct directory structure is as follows:
modules -directory
ckeditor -directory
ckeditor.module
ckeditor.admin.inc
...
ckeditor -directory
_source -directory
images -directory
lang -directory
plugins -directory
skins -directory
themes -directory
COPY_HERE.txt
ckeditor.js
...
## Plugins: Teaser break and Pagebreak
By default, CKEditor module comes with two plugins that can handle
teaser break (<!--break-->) and pagebreak (<!--pagebreak-->).
Both plugins are automatically enabled.
1. To add 'DrupalBreak' and 'DrupalPageBreak' buttons to the toolbar,
open sites/all/modules/ckeditor/ckeditor.config.js and add them to the toolbar
definiton (both buttons are enabled in DrupalFiltered and DrupalFull
toolbars by default).
The 'DrupalBreak' button will automatically disappear from the toolbar
on textareas where teaser cannot be created.
2. Note that the <!--pagebreak--> tag is not supported by default in Drupal.
You should install the Paging module: <http://drupal.org/project/paging>
to enable the <!--pagebreak--> tag support. Please refer to the Paging
module documentation for detailed installation instructions.
If you don't install Paging module, the 'DrupalPageBreak' will automatically disappear.
## Uploading images and files
There are three ways of uploading files: By using commercial file browser like CKFinder (<http://ckfinder.com>),
by using modules like IMCE, WebFM, Image Browser or by using the core upload module.
To select preferred file browser, under "Administer > Site configuration > CKEditor", adjust
CKEditor profiles. In each profile you can choose which file browser will be used (in "File browser settings" section).
Note: to choose IMCE, WebFM or Image Browser you should install an appropiate Drupal module first.
## How to install CKFinder
CKFinder is an AJAX based file manager created by CKEditor developers: <http://ckfinder.com/>.
1. Download CKFinder for PHP: <http://ckfinder.com/download>
2. Unpack CKFinder to the directory with the CKEditor module (into sites/all/modules/ckeditor/ckfinder)
The correct directory structure is as follows:
modules -directory
ckeditor -directory
ckeditor.module
ckeditor.admin.inc
...
ckfinder -directory
core -directory
ckfinder.php
config.php
...
ckeditor -directory
_source -directory
images -directory
ckeditor.js
...
3. Grant "allow CKFinder file uploads" permission in "Administer > User Management > Permissions"
Note: if you don't see such permission then it means that CKEditor didn't find CKFinder
and you have probably uploaded CKFinder into wrong directory.
4. Open CKFinder configuration file (sites/all/modules/ckeditor/ckfinder/config.php) and do the following:
I) remove the CheckAuthentication() function:
(don't worry, this function is defined in filemanager.config.php, see below)
function CheckAuthentication() <- remove it
{ <- remove it
//WARNING : DO NOT simply... <- remove it
... <- remove it
return false; <- remove it
} <- remove it
II) add:
require_once '../../../../includes/filemanager.config.php';
straight below the following line:
$baseDir = resolveUrl($baseUrl);
5. Select CKFinder as preferred file browser in "Administer > Site configuration > CKEditor"
(in selected CKEditor profile scroll down to "File browser settings" section).
In the "File browser settings" section you may also change destination folders for files uploaded with CKFinder.
## Upgrading instructions (migration from FCKeditor)
During the installation, CKEditor will check for the existence of FCKeditor module and
copy all FCKeditor settings, profiles etc. (to save your time, just disable FCKeditor module
during CKEditor installation, if you unistall FCKeditor module before installing CKEditor,
all FCKeditor settings will be deleted from the database and CKEditor will not copy them).
After installing CKEditor you may unsinstall FCKeditor module.
If both modules are enabled (CKEditor and FCKeditor) you may get javascript errors, if both editors
will try to attach to the same textarea, be sure that's not a problem if you have problems after upgrading.
Apart from the information above, installing CKEditor is just like installing a new module,
so be sure to follow the installation instruction.
## Upgrading instructions (CKEditor)
This instruction assumes that you are upgrading CKEditor module [M] and CKEditor [the editor](E) at the same time.
Instructions specific for module upgrades are tagged with [M], steps that must be taken when upgrading CKEditor (the editor) are marked with [E].
1. [M] Download the latest version of CKEditor module from <http://drupal.org/project/ckeditor> (it is advised to read release notes before going further).
2. [E] Download the latest version of CKEditor from <http://ckeditor.com/download> (it is advised to read "what's new" before going further: <http://ckeditor.com/whatsnew>).
3. [M] Back up your database.
4. [EM] Place the site in "Off-line" mode, to let the database updates run without interruption and avoid displaying errors to end users of the site.
5. [E] If you are using CKFinder, make sure you'll not delete it, move it into a safe place.
6. [E] If you have made any changes inside of sites/all/modules/ckeditor/ckeditor.config.js (or sites/all/modules/ckeditor/ckeditor/config.js), write down your changes and add them again after uploading new files (e.g. own toolbar definitions etc.).
Try to not make any changes to CKEditor's config.js and add everything to ckeditor.config.js.
7. Delete old files:
[EM]* Simply remove modules/ckeditor directory if upgrading both, the editor and the module.
[M] If you are upgrading module only, remember to leave the modules/ckeditor/ckeditor directory.
[E] When upgrading the editor, remove contents of modules/ckeditor/ckeditor directory only.
WARNING: if you don't remove old files and just rename ckeditor directory instead e.g. to ckeditor_old, Drupal may use module from the ckeditor_old directory.
8. [M] Upload CKEditor module (extracted files and folders) to sites/all/modules directory.
9. [E] Upload CKEditor (extracted files and folders from the ckeditor directory) to sites/modules/ckeditor/ckeditor (i.e. where COPY HERE.txt file exists)
10. [E] Copy back CKFinder (see step 5)
11. [E] Apply your modifications to default configuration in ckeditor.config.js file (see step 6).
12. [M] Run update.php.
13. [EM] Put the site back online.
## Maintainers
- Lauri Timmanee [@lauriii](https://www.drupal.org/u/lauriii)
- Théodore Biadala [@nod_](https://www.drupal.org/u/nod_)
- Wim Leers [@wim-leers](https://www.drupal.org/u/wim-leers)
- Wiktor Walc [@wwalc](https://www.drupal.org/u/wwalc)
- Jess [@xjm](https://www.drupal.org/u/xjm)
- Jorrit Schippers [@jorrit](https://www.drupal.org/u/jorrit)
- Magnus [@magnus](https://www.drupal.org/u/magnus)
- Pawel Wiaderny [@p.wiaderny](https://www.drupal.org/u/pwiaderny)
- Robert Mikołajuk [@vokiel](https://www.drupal.org/u/vokiel)
- Hai-Nam Nguyen [@jcisio](https://www.drupal.org/u/jcisio)
- dczepierga [@911466](https://www.drupal.org/user/911466)
- mkesicki [@922884](https://www.drupal.org/user/922884)
- Anna Tomanek [@Anna_CKSource](https://www.drupal.org/u/anna_cksource)