|
1 $Id: README.txt,v 1.16.2.14 2008/12/12 19:45:25 wwalc Exp $ |
|
2 |
|
3 CONTENTS OF THIS FILE |
|
4 --------------------- |
|
5 |
|
6 * Overview |
|
7 * Required components |
|
8 * More information and licence |
|
9 * Requirements |
|
10 * Configuration |
|
11 * Installation troubleshooting |
|
12 * Plugins: Teaser break and Pagebreak |
|
13 * Uploading images and files |
|
14 * How to enable the built-in file browser |
|
15 * Modules: Image Assist |
|
16 * Modules: Link to content (EXPERIMENTAL) |
|
17 * Upgrading instructions |
|
18 * Help & Contribution |
|
19 * Credits |
|
20 |
|
21 Overview |
|
22 -------- |
|
23 This module allows Drupal to replace textarea fields with the |
|
24 FCKeditor. |
|
25 This HTML text editor brings many of the powerful functions of known |
|
26 desktop editors like Word to the web. It's relatively lightweight and |
|
27 doesn't require any kind of installation on the client computer. |
|
28 |
|
29 Required components |
|
30 ------------------- |
|
31 To use FCKeditor in Drupal, you will need to download the FCKeditor |
|
32 http://www.fckeditor.net/ |
|
33 |
|
34 More information and licence |
|
35 ---------------------------- |
|
36 FCKeditor - The text editor for internet |
|
37 Copyright (C) 2003-2008 Frederico Caldeira Knabben |
|
38 |
|
39 Licensed under the terms of the GNU Lesser General Public License: |
|
40 http://www.opensource.org/licenses/lgpl-license.php |
|
41 |
|
42 For further information visit: |
|
43 http://www.fckeditor.net/ |
|
44 http://drupal.fckeditor.net |
|
45 |
|
46 Requirements |
|
47 ------------ |
|
48 - Drupal 6.x |
|
49 - PHP 4.3.0 or greater |
|
50 - FCKeditor 2.3.x or greater (http://www.fckeditor.net/) |
|
51 |
|
52 Configuration |
|
53 ------------------- |
|
54 Note: this instruction assumes that you install FCKeditor in |
|
55 sites/all/modules directory (recommended). |
|
56 |
|
57 1. Unzip the files in the sites/all/modules directory. It should now |
|
58 contain a fckeditor directory. |
|
59 2. Download FCKeditor from http://www.fckeditor.net/download. Unzip the |
|
60 contents of the fckeditor directory in the |
|
61 sites/all/modules/fckeditor/fckeditor directory. |
|
62 3. Enable the module as usual from Drupal's admin pages. |
|
63 4. Grant permissions for use of FCKeditor in |
|
64 "Administer > User Management > Permissions" |
|
65 Note: to enable the file browser, read also the |
|
66 "How to enable the file browser" section. |
|
67 5. Under "Administer > Site configuration > FCKeditor", adjust |
|
68 the fckeditor profiles. In each profile you can choose which textareas |
|
69 will be replaced by FCKeditor, select default toolbar and configure |
|
70 some more advanced settings. |
|
71 6. For the Rich Text Editing to work you also need to configure your filters |
|
72 for the users that may access Rich Text Editing. |
|
73 Either grant those users Full HTML access or use the following: |
|
74 <a> <p> <span> <div> <h1> <h2> <h3> <h4> <h5> <h6> <img> <map> <area> <hr> |
|
75 <br> <br /> <ul> <ol> <li> <dl> <dt> <dd> <table> <tr> <td> <em> <b> <u> <i> <strong> |
|
76 <font> <del> <ins> <sub> <sup> <quote> <blockquote> <pre> <address> <code> |
|
77 <cite> <embed> <object> <param> <strike> <caption>. |
|
78 7. To have a better control over line breaks, you may disable Line break converter |
|
79 in the chosen filter (recommended). |
|
80 8. Modify the fckeditor.config.js file to custom your needs (optional). |
|
81 You may copy the needed configuration lines from the default FCKeditor |
|
82 configuration settings (sites/all/modules/fckeditor/fckeditor/fckconfig.js), |
|
83 the lines in fckeditor.config.js will override most settings. |
|
84 In fckeditor.config.js you may define your own toolbars with selected buttons. |
|
85 WARNING: clear browser's cache after you modify any of the javascript files. |
|
86 If you don't do this, you may notice that browser is ignoring all your changes. |
|
87 |
|
88 Installation troubleshooting |
|
89 ---------------------------- |
|
90 If your FCKeditor does not show you must check if all files are |
|
91 extracted correctly. |
|
92 The directory sites/all/modules/fckeditor/fckeditor/ should have the |
|
93 following files: |
|
94 - fckeditor.js |
|
95 - fckconfig.js |
|
96 - fckstyles.xml |
|
97 - fcktemplates.xml |
|
98 and a directory named editor. |
|
99 |
|
100 The correct directory structure is as follows: |
|
101 modules |
|
102 fckeditor |
|
103 fckeditor.module |
|
104 fckeditor |
|
105 _samples |
|
106 editor |
|
107 COPY_HERE.txt |
|
108 fckconfig.js |
|
109 ... |
|
110 |
|
111 If you're still having problems, scroll down to the "Help & Contribution" section. |
|
112 |
|
113 Plugins: Teaser break and Pagebreak |
|
114 ----------------------------------- |
|
115 By default, FCKeditor module comes with two plugins that can handle |
|
116 teaser break (<!--break-->) and pagebreak (<!--pagebreak-->). |
|
117 You can enable any (or even both) of them. |
|
118 |
|
119 1. Open sites/all/modules/fckeditor/fckeditor.config.js and |
|
120 uncomment these three lines: |
|
121 |
|
122 FCKConfig.PluginsPath = '../../plugins/' ; |
|
123 FCKConfig.Plugins.Add( 'drupalbreak' ) ; |
|
124 FCKConfig.Plugins.Add( 'drupalpagebreak' ) ; |
|
125 |
|
126 |
|
127 2. The second step is to add buttons to the toolbar (in the same file). |
|
128 The button names are: DrupalBreak, DrupalPageBreak. |
|
129 For example if you have a toolbar with an array of buttons defined |
|
130 as follows: |
|
131 |
|
132 ['Image','Flash','Table','Rule','SpecialChar'] |
|
133 |
|
134 simply add those two buttons at the end of array: |
|
135 |
|
136 ['Image','Flash','Table','Rule','SpecialChar', 'DrupalBreak', 'DrupalPageBreak'] |
|
137 |
|
138 (remember about single quotes). |
|
139 |
|
140 3. Note that the <!--pagebreak--> tag is not supported by default in Drupal. |
|
141 You should install the Paging module: http://drupal.org/project/paging |
|
142 to enable the <!--pagebreak--> tag support. Please refer to the Paging |
|
143 module documentation for detailed installation instructions. |
|
144 |
|
145 Uploading images and files |
|
146 -------------------------- |
|
147 |
|
148 There are three ways of uploading files: By using the built-in file browser, |
|
149 by using modules like IMCE, Image Browser or by using the core upload module. |
|
150 |
|
151 How to enable the file browser |
|
152 ------------------------------ |
|
153 The editor gives the end user the flexibility to create a custom file browser |
|
154 that can be integrated on it. |
|
155 The included file browser allows users to view the content of a specific |
|
156 directory on the server and add new content to that directory |
|
157 (create folders and upload files). |
|
158 |
|
159 1. To enable file browsing you need to edit the connector configuration file |
|
160 in your fckeditor module directory, the file should be in: |
|
161 |
|
162 sites/all/modules/fckeditor/fckeditor/editor/filemanager/connectors/php/config.php |
|
163 (FCKeditor 2.5+) |
|
164 |
|
165 or |
|
166 |
|
167 sites/all/modules/fckeditor/fckeditor/editor/filemanager/browser/default/connectors/php/config.php |
|
168 and |
|
169 sites/all/modules/fckeditor/fckeditor/editor/filemanager/upload/php/config.php |
|
170 (FCKeditor 2.3.x - 2.4.x) |
|
171 |
|
172 In this file(s) you will need to enable the file browser by adding one |
|
173 line that includes file with the special authentication function for |
|
174 Drupal (filemanager.config.php). Add this code: |
|
175 |
|
176 require_once "../../../../../filemanager.config.php"; |
|
177 (FCKeditor 2.5+) |
|
178 |
|
179 or |
|
180 |
|
181 require_once "D:\\xampp\\htdocs\\drupal\\sites\\all\\modules\\fckeditor\\filemanager.config.php" |
|
182 (FCKeditor 2.3.x - 2.4.x) |
|
183 |
|
184 straight below this line: |
|
185 |
|
186 $Config['UserFilesAbsolutePath'] = '' ; |
|
187 |
|
188 The config.php file also holds some other important settings, please |
|
189 take a look at it and adjust it to your needs (optional). |
|
190 |
|
191 2. As of Drupal 5.2, additional step is required: locate file named |
|
192 settings.php inside your drupal directory (usually sites/default/settings.php) |
|
193 and set $cookie_domain variable to the appropiate domain |
|
194 (remember to uncomment that line). If you not do this, FCKeditor will |
|
195 claim that file browser is disabled |
|
196 |
|
197 3. Enabling file uploads is a security risk. That's why you have to grant a |
|
198 separate permission to enable the file browser to certain groups. |
|
199 In "Administer > User Management > Permissions" assign the |
|
200 "allow fckeditor file uploads" permissions. |
|
201 |
|
202 4. Lastly, adjust the File browser settings for each profile. |
|
203 |
|
204 Modules: Image Assist |
|
205 --------------------- |
|
206 Image Assist can be integrated with FCKeditor. |
|
207 To do this, simply copy the modules/fckeditor/img_assist_fckeditor.js file to modules/img_assist/img_assist_fckeditor.js. |
|
208 |
|
209 Modules: Link to content (EXPERIMENTAL) |
|
210 --------------------------------------- |
|
211 Link to content module can be integrated with FCKeditor. |
|
212 ATTENTION: this module is not yet compatible with FCKeditor :( |
|
213 |
|
214 The unofficial version of Link to content module compatible with FCKeditor can be downloaded here: |
|
215 http://drupal.fckeditor.net/download/linktocontent-fckeditor-6.x-2.x-dev.zip |
|
216 |
|
217 Installation: |
|
218 Follow the instruction from INSTALL.txt attached to the linktocontent module. |
|
219 Then do the following steps to add Linktocontent button to the FCKeditor toolbar: |
|
220 |
|
221 By default, FCKeditor module comes with two plugins that allows you to use linktocontent and linktonode features. |
|
222 You can enable any (or even both) of them. |
|
223 |
|
224 1. Open /drupal/modules/fckeditor/fckeditor.config.js and uncomment these three lines: |
|
225 |
|
226 FCKConfig.PluginsPath = '../../plugins/' ; |
|
227 FCKConfig.Plugins.Add( 'linktonode', 'en,pl' ) ; |
|
228 FCKConfig.Plugins.Add( 'linktomenu', 'en,pl' ) ; |
|
229 |
|
230 2. The second step is to add buttons to the toolbar (in the same file). |
|
231 The button names are: LinkToNode, LinkToMenu. |
|
232 For example if you have a toolbar with an array of buttons defined as follows: |
|
233 |
|
234 ['Link','Unlink','Anchor'] |
|
235 |
|
236 simply add those two buttons at the end of array (or somewhere in the middle): |
|
237 |
|
238 ['Link','Unlink','LinkToNode','LinkToMenu','Anchor'] |
|
239 |
|
240 (remember about single quotes). |
|
241 |
|
242 Upgrading instructions |
|
243 ---------------------- |
|
244 This instruction assumes that you are upgrading FCKeditor module [M] and FCKeditor (the editor)[E] at the same time. |
|
245 Instructions specific for module upgrades are tagged with [M], steps that must be taken when upgrading FCKeditor (the editor) are marked with [E]. |
|
246 |
|
247 1. [M] Download the latest version of FCKeditor module from http://drupal.org/project/fckeditor (it is advised to read release notes before going further). |
|
248 2. [E] Download the latest version of FCKeditor from http://www.fckeditor.net/download (it is advised to read "what's new" before going further: http://www.fckeditor.net/whatsnew). |
|
249 3. [M] Back up your database. |
|
250 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. |
|
251 5. [E] If you have used the FCKeditor built-in file browser, make a backup of sites/all/modules/fckeditor/fckeditor/editor/filemanager/connectors/php/config.php |
|
252 6. [E] If you have configured spellchecker, make a backup of sites/all/modules/fckeditor/fckeditor/editor/dialog/fck_spellerpages/spellerpages/server-scripts/spellchecker.php |
|
253 7. [E] If you have made any changes inside of sites/all/modules/fckeditor/fckeditor.config.js (or sites/all/modules/fckeditor/fckeditor/fckconfig.js), write down your changes and add them again after uploading new files (e.g. own toolbar definitions, re-enable a plugin etc.). Try to not make any changes to fckconfig.js and add everything to fckeditor.config.js. |
|
254 8. Delete old files: |
|
255 [EM]* Simply remove modules/fckeditor directory if upgrading both, the editor and the module. |
|
256 [M] If you are upgrading module only, remember to leave the modules/fckeditor/fckeditor directory. |
|
257 [E] When upgrading the editor, remove contents of modules/fckeditor/fckeditor directory only. |
|
258 WARNING: if you don't remove old files and just rename fckeditor directory instead e.g. to fckeditor_old, Drupal may use module from the fckeditor_old directory. |
|
259 9. [M] Upload FCKeditor module (extracted files and folders) to sites/all/modules directory. |
|
260 10. [E] Upload FCKeditor (extracted files and folders from the fckeditor directory) to sites/modules/fckeditor/fckeditor (i.e. where COPY HERE.txt file exists) |
|
261 11. [E] Replace the new config.php (see step 5) file with the old one (or RECOMMENDED way: perform again step with adding require_once '../../../../../filemanager.config.php'; to config.php) |
|
262 12. [E] Replace the new spellchecker.php with the old one (see step 6) (or RECOMMENDED way: configure new spellchecker.php following the settings from the old file). |
|
263 13. [E] Apply your modifications to default configuration in fckeditor.config.js file (see step 7). |
|
264 14. [M] If you're using Image Assist module, copy the new img_assist_fckeditor.js to modules/img_assist folder. |
|
265 15. [M] Run update.php. |
|
266 16. [EM] Put the site back online. |
|
267 |
|
268 Help & Contribution |
|
269 ------------------- |
|
270 If you are looking for more information, have any troubles in configuration or if |
|
271 you found an issue, please visit the official project page: |
|
272 http://drupal.org/project/fckeditor |
|
273 |
|
274 Having problems? Take a look at list of common problems when installing FCKeditor: |
|
275 http://drupal.fckeditor.net/troubleshooting |
|
276 |
|
277 How to tune up FCKeditor to your theme: |
|
278 http://drupal.fckeditor.net/tricks |
|
279 |
|
280 We would like to encourage you to join our team if you can help in any way. |
|
281 If you can translate FCKeditor module, please use fckeditor.pot file as a template |
|
282 (located in "po" directory) and send us the translated file so that we could attach it. |
|
283 Any help is appreciated. |
|
284 |
|
285 Credits |
|
286 ------- |
|
287 - FCKeditor for Drupal Core functionality originally written by: |
|
288 Frederico Caldeira Knabben |
|
289 Jorge Tite (LatPro Inc.) |
|
290 |
|
291 - FCKeditor for Drupal 5.x originally written by: |
|
292 Ontwerpwerk (www.ontwerpwerk.nl) |
|
293 |
|
294 - FCKeditor for Drupal 5.x is currently maintained by FCKeditor team. |
|
295 http://www.fckeditor.net/ |
|
296 |
|
297 - FCKeditor - The text editor for internet |
|
298 Copyright (C) 2003-2006 Frederico Caldeira Knabben |
|
299 http://www.fckeditor.net/ |