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