Stripping CVS keywords
[project/fckeditor.git] / README.txt
CommitLineData
e44c2389 1
d739bfad
JT
2Overview
3--------
0c87a920
WW
4This module allows Drupal to replace textarea fields with the
5FCKeditor.
6This HTML text editor brings many of the powerful functions of known
7desktop editors like Word to the web. It's relatively lightweight and
8doesn't require any kind of installation on the client computer.
e44c2389 9
e44c2389 10Required components
11-------------------
12To use FCKeditor in Drupal, you will need to download the FCKeditor
13http://www.fckeditor.net/
f3d88ca0 14
e44c2389 15More information and licence
16----------------------------
d739bfad 17FCKeditor - The text editor for internet
f3d88ca0 18Copyright (C) 2003-2006 Frederico Caldeira Knabben
ebc6fdec 19
d739bfad 20Licensed under the terms of the GNU Lesser General Public License:
e44c2389 21 http://www.opensource.org/licenses/lgpl-license.php
d739bfad
JT
22
23For further information visit:
e44c2389 24 http://www.fckeditor.net/
c01081e7 25 http://drupal.fckeditor.net
d739bfad
JT
26
27Requirements
28------------
9b429add 29 - Drupal 5.x
e44c2389 30 - PHP 4.3.0 or greater
0c87a920 31 - FCKeditor 2.3.x or greater (http://www.fckeditor.net/)
63a392a2 32
d739bfad 33Configuration
c01081e7
WW
34-------------------
35 1. Enable the module as usual from Drupal's admin pages.
36 2. Grant permissions for use of FCKeditor in Administer > User Management > Access Control
37 3. Under Administer > Settings > FCKeditor, create the fckeditor profiles.
38 In each profile you can choose which textareas will be replaced by FCKeditor,
39 select default toolbar and configure some more advanced settings
40 4. For the Rich Text Editing to work you also need to configure your filters for the users that may access Rich Text Editing.
41 Either grant those users Full HTML access or use the following:
42 <a> <p> <span> <div> <h1> <h2> <h3> <h4> <h5> <h6> <img> <map> <area> <hr>
43 <br> <br /> <ul> <ol> <li> <dl> <dt> <dd> <table> <tr> <td> <em> <b> <u> <i> <strong>
44 <font> <del> <ins> <sub> <sup> <quote> <blockquote> <pre> <address> <code>
45 <cite> <embed> <object> <strike> <caption>.
46 5. To have a better control over line breaks, you may disable Line break converter in the chosen filter (recommended).
47 6. Modify the fckeditor.config.js file to custom your needs (optional).
48 You may copy the needed configuration lines from the default FCKeditor configuration settings (modules/fckeditor/fckeditor/fckconfig.js),
49 the lines in fckeditor.config.js will override most settings.
50
51Installation troubleshooting
52----------------------------
53If your FCKeditor does not show you must check if all files are extracted correctly.
54The directory /drupal5b/modules/fckeditor/fckeditor/ should have the following files:
55fckeditor.js, fckconfig.js, fckstyles.xml, fcktemplates.xml and a directory named editor.
56The correct directory structure is as follows:
57
58 modules
59 fckeditor
60 fckeditor.module
61 fckeditor
62 _samples
63 editor
64 COPY_HERE.txt
65 fckconfig.js
66 ...
67
0c87a920
WW
68Plugins: Teaser break and Pagebreak
69-----------------------------------
c01081e7 70By default, FCKeditor module comes with two plugins that can handle teaser break (<!--break-->) and pagebreak (<!--pagebreak-->).
0c87a920 71You can enable any (or even both) of them.
c01081e7
WW
72
73 1. Open /drupal5b/modules/fckeditor/fckeditor.config.js and uncomment these three lines:
74
75 FCKConfig.PluginsPath = '../../plugins/' ;
76 FCKConfig.Plugins.Add( 'drupalbreak' ) ;
77 FCKConfig.Plugins.Add( 'drupalpagebreak' ) ;
78
79
80 2. The second step is to add buttons to the toolbar (in the same file).
81 The button names are: DrupalBreak, DrupalPageBreak.
82 For example if you have a toolbar with an array of buttons defined as follows:
83
84 ['Image','Flash','Table','Rule','SpecialChar']
85
86 simply add those two buttons at the end of array:
87
88 ['Image','Flash','Table','Rule','SpecialChar', 'DrupalBreak', 'DrupalPageBreak']
89
90 (remember about single quotes).
91
92Uploading images and files
93--------------------------
94
95There are three ways of uploading files: By using the built-in file browser, by using a module like IMCE or using the core upload module.
96
97How to enable the file browser
98------------------------------
99The editor gives the end user the flexibility to create a custom file browser that can be integrated on it.
100The included file browser allows users to view the content of a specific directory on
101the server and add new content to that directory (create folders and upload files).
102
103 1. To enable file browsing you need to edit the connector configuration file in your fckeditor module directory, the file should be in:
104
105 /drupal5b/modules/fckeditor/fckeditor/editor/filemanager/connectors/php/config.php
106 (FCKeditor 2.5+)
107
108 or
109
110 /drupal5b/modules/fckeditor/fckeditor/editor/filemanager/browser/default/connectors/php/config.php
111 and
112 /drupal5b/modules/fckeditor/fckeditor/editor/filemanager/upload/php/config.php
113 (FCKeditor 2.3.x - 2.4.x)
114
115 In this file(s) you will need to enable the file browser by adding one line that includes file with the special authentication function for Drupal (filemanager.config.php). Add this code:
116
117 require_once "../../../../../filemanager.config.php";
118 (FCKeditor 2.5+)
119
120 or
121
122 require_once "D:\\xampp\\htdocs\\drupal5b\\modules\\fckeditor\\filemanager.config.php"
123 (FCKeditor 2.3.x - 2.4.x)
124
125 straight below this line:
126
127 $Config['UserFilesAbsolutePath'] = '' ;
128
129 The config.php file also holds some other important settings, please take a look at it and adjust it to your needs (optional).
130
131 2. As of Drupal 5.2, additional step is required: locate file named settings.php inside
132 your drupal directory (usually sites/default/settings.php) and set $cookie_domain variable to the appropiate domain (remember to uncomment that line). If you not do this, FCKeditor will claim that file browser is disabled
133 3. Enabling file uploads is a security risk. That's why you have to grant a separate permission to enable the file browser to certain groups.
134 4. Lastly, adjust the File browser settings for each profile.
135
136Modules: Image Assist
137---------------------
138Image Assist can be integrated with FCKeditor.
139To do this, simply copy the modules/fckeditor/img_assist_fckeditor.js file to modules/img_assist/img_assist_fckeditor.js.
0c87a920
WW
140
141Help & Contribution
142-------------------
143If you are looking for more information, have any troubles in configuration or if
144you found an issue, please visit the official project page:
145 http://drupal.org/project/fckeditor
146
147We would like to encourage you to join our team if you can help in any way.
148If you can translate FCKeditor module, please use fckeditor.pot file as a template
149(located in "po" directory) and send us the translated file so that we could attach it.
150Any help is appreciated.
151
d739bfad
JT
152Credits
153-------
9fd81688 154 - FCKeditor for Drupal Core functionality originally written by:
f3d88ca0 155 Frederico Caldeira Knabben
156 Jorge Tite (LatPro Inc.)
157
0c87a920 158 - FCKeditor for Drupal 5.x originally written by:
f3d88ca0 159 Ontwerpwerk (www.ontwerpwerk.nl)
0c87a920
WW
160
161 - FCKeditor for Drupal 5.x is currently maintained by FCKeditor team.
162 http://www.fckeditor.net/
f3d88ca0 163
9fd81688 164 - FCKeditor - The text editor for internet
f3d88ca0 165 Copyright (C) 2003-2006 Frederico Caldeira Knabben
9fd81688 166 http://www.fckeditor.net/