You are here

README.txt in FCKeditor - WYSIWYG HTML editor 5

Same filename and directory in other branches
  1. 5.2 README.txt
  2. 6.2 README.txt
  3. 6 README.txt
Overview
--------
This module allows Drupal to replace textarea fields with the
FCKeditor.
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.

Compatibility
-------------
The integrated File Browser needs a bit of manual configuration,
more information about this in the included in this readme.txt file

Required components
-------------------
To use FCKeditor in Drupal, you will need to download the FCKeditor
http://www.fckeditor.net/

More information and licence
----------------------------
FCKeditor - The text editor for internet
Copyright (C) 2003-2006 Frederico Caldeira Knabben

Licensed under the terms of the GNU Lesser General Public License:
    http://www.opensource.org/licenses/lgpl-license.php

For further information visit:
    http://www.fckeditor.net/

Requirements
------------
  - Drupal 5.x
  - PHP 4.3.0 or greater
  - FCKeditor 2.3.x (http://www.fckeditor.net/)

Installation
------------
  1. Copy the module fckeditor folder to modules/.
  2. Download FCKeditor 2.x from http://www.fckeditor.net and copy
     the distribution files (the contents of the "fckeditor" directory
     from the FCKeditor distribution file) to
     modules/fckeditor/fckeditor.
     
     A quick check to see if it is correct: the files 'COPY_HERE.txt',
     'fckconfig.js' and also the directory 'editor' must exist in the
     same directory,
     
  3. See 'How to enable the File Browser' for additional instructions.

     Also read the security note in this readme

     Alternatives to the built-in file browser are the IMCE module and
     copying the image url into the url textfield.

Configuration
-------------
  1. Modify the fckeditor.config.js file to customize the toolbars to
     your needs (optional).

     You may also copy the needed configuration lines from the default
     FCKeditor configuration settings
     (modules/fckeditor/fckeditor/fckconfig.js), the lines in
     fckeditor.config.js will override most settings.

     It is not advised to change the default toolbars in the
     configuration settings (modules/fckeditor/fckeditor/fckconfig.js)
     because those are included in the FCKeditor package and might
     change without notice when you update the editor.
  
  2. Enable the module as usual from Drupal's admin pages.
  
  3. Under Administer > Settings > FCKeditor, configure the fckeditor
     settings. You can choose which textareas will be replaced by
     FCKeditor, choose the toolbars and configure some more advanced
     settings.

  4. Grant permissions for use of FCKeditor in
     Administer > User Management > Access Control (You only need to
     select either basic or advanced editor for each role that is
     allowed to use the FCKeditor because the advanced will override
     the basic permission)

  5. 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 following:
      <a> <em> <strong> <small> <sup> <sub> <cite> <blockquote> <code>
      <ul> <ol> <li> <dl> <dt> <dd> <h2> <h3> <h4> <img> <br> <br />
      <p> <div> <span> <b> <i>
     Users that need access to tables might be better of using
     Full HTML

How to enable the File Browser (in FCKeditor 2.3.x)
---------------------------------------------------
The editor gives the end user the flexibility to create a custom file
browser that can be integrated on it. The included file browser allows
users to view the content of a specific directory on the server and
add new content to that directory (create folders and upload files).

To enable the file browser you need to edit the connector
configuration file in your fckeditor module directory, the file should
be in:
/modules/fckeditor/fckeditor/editor/filemanager/browser/default/connectors/php/config.php
and
/modules/fckeditor/fckeditor/editor/filemanager/upload/php/config.php

In this file you will need to enable the file browser:
  $Config['Enabled'] = true ;

To use the drupal files directory you also need to comment out or
remove the following line in the connector configuration:
  $Config['UserFilesPath'] = '/UserFiles/' ;
You may also edit this line to reflect a custom upload path.

Furthermore, you will need to create a "File", "Image", "Flash" and
"Media" subdirectory in your drupal files directory. These directories
must have the same privileges as the drupal files directory. In some
cases these directories must be world writable (chmod 0777).

Security
--------
Note that enabling file uploads is a security risk. That's why there
is a separate permission in Administer > Access Control for enabling
the file browser to certain groups.

Credits
-------
 - FCKeditor for Drupal Core functionality originally written by:
     Frederico Caldeira Knabben
     Jorge Tite (LatPro Inc.)

 - FCKeditor for Drupal 5.x
     Ontwerpwerk (www.ontwerpwerk.nl)

 - FCKeditor - The text editor for internet
     Copyright (C) 2003-2006 Frederico Caldeira Knabben
     http://www.fckeditor.net/

File

README.txt
View source
  1. Overview
  2. --------
  3. This module allows Drupal to replace textarea fields with the
  4. FCKeditor.
  5. This HTML text editor brings many of the powerful functions of known
  6. desktop editors like Word to the web. It's relatively lightweight and
  7. doesn't require any kind of installation on the client computer.
  8. Compatibility
  9. -------------
  10. The integrated File Browser needs a bit of manual configuration,
  11. more information about this in the included in this readme.txt file
  12. Required components
  13. -------------------
  14. To use FCKeditor in Drupal, you will need to download the FCKeditor
  15. http://www.fckeditor.net/
  16. More information and licence
  17. ----------------------------
  18. FCKeditor - The text editor for internet
  19. Copyright (C) 2003-2006 Frederico Caldeira Knabben
  20. Licensed under the terms of the GNU Lesser General Public License:
  21. http://www.opensource.org/licenses/lgpl-license.php
  22. For further information visit:
  23. http://www.fckeditor.net/
  24. Requirements
  25. ------------
  26. - Drupal 5.x
  27. - PHP 4.3.0 or greater
  28. - FCKeditor 2.3.x (http://www.fckeditor.net/)
  29. Installation
  30. ------------
  31. 1. Copy the module fckeditor folder to modules/.
  32. 2. Download FCKeditor 2.x from http://www.fckeditor.net and copy
  33. the distribution files (the contents of the "fckeditor" directory
  34. from the FCKeditor distribution file) to
  35. modules/fckeditor/fckeditor.
  36. A quick check to see if it is correct: the files 'COPY_HERE.txt',
  37. 'fckconfig.js' and also the directory 'editor' must exist in the
  38. same directory,
  39. 3. See 'How to enable the File Browser' for additional instructions.
  40. Also read the security note in this readme
  41. Alternatives to the built-in file browser are the IMCE module and
  42. copying the image url into the url textfield.
  43. Configuration
  44. -------------
  45. 1. Modify the fckeditor.config.js file to customize the toolbars to
  46. your needs (optional).
  47. You may also copy the needed configuration lines from the default
  48. FCKeditor configuration settings
  49. (modules/fckeditor/fckeditor/fckconfig.js), the lines in
  50. fckeditor.config.js will override most settings.
  51. It is not advised to change the default toolbars in the
  52. configuration settings (modules/fckeditor/fckeditor/fckconfig.js)
  53. because those are included in the FCKeditor package and might
  54. change without notice when you update the editor.
  55. 2. Enable the module as usual from Drupal's admin pages.
  56. 3. Under Administer > Settings > FCKeditor, configure the fckeditor
  57. settings. You can choose which textareas will be replaced by
  58. FCKeditor, choose the toolbars and configure some more advanced
  59. settings.
  60. 4. Grant permissions for use of FCKeditor in
  61. Administer > User Management > Access Control (You only need to
  62. select either basic or advanced editor for each role that is
  63. allowed to use the FCKeditor because the advanced will override
  64. the basic permission)
  65. 5. For the Rich Text Editing to work you also need to configure your
  66. filters for the users that may access Rich Text Editing. Either
  67. grant those users Full HTML access or use the following:


      1. Users that need access to tables might be better of using
      2. Full HTML
      3. How to enable the File Browser (in FCKeditor 2.3.x)
      4. ---------------------------------------------------
      5. The editor gives the end user the flexibility to create a custom file
      6. browser that can be integrated on it. The included file browser allows
      7. users to view the content of a specific directory on the server and
      8. add new content to that directory (create folders and upload files).
      9. To enable the file browser you need to edit the connector
      10. configuration file in your fckeditor module directory, the file should
      11. be in:
      12. /modules/fckeditor/fckeditor/editor/filemanager/browser/default/connectors/php/config.php
      13. and
      14. /modules/fckeditor/fckeditor/editor/filemanager/upload/php/config.php
      15. In this file you will need to enable the file browser:
      16. $Config['Enabled'] = true ;
      17. To use the drupal files directory you also need to comment out or
      18. remove the following line in the connector configuration:
      19. $Config['UserFilesPath'] = '/UserFiles/' ;
      20. You may also edit this line to reflect a custom upload path.
      21. Furthermore, you will need to create a "File", "Image", "Flash" and
      22. "Media" subdirectory in your drupal files directory. These directories
      23. must have the same privileges as the drupal files directory. In some
      24. cases these directories must be world writable (chmod 0777).
      25. Security
      26. --------
      27. Note that enabling file uploads is a security risk. That's why there
      28. is a separate permission in Administer > Access Control for enabling
      29. the file browser to certain groups.
      30. Credits
      31. -------
      32. - FCKeditor for Drupal Core functionality originally written by:
      33. Frederico Caldeira Knabben
      34. Jorge Tite (LatPro Inc.)
      35. - FCKeditor for Drupal 5.x
      36. Ontwerpwerk (www.ontwerpwerk.nl)
      37. - FCKeditor - The text editor for internet
      38. Copyright (C) 2003-2006 Frederico Caldeira Knabben
      39. http://www.fckeditor.net/