profiles/glorillacom/FCKeditor-readme.txt

$Id: README.txt,v 1.15.2.2.2.3 2008/02/09 16:00:14 wwalc Exp $

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.

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/
    http://drupal.fckeditor.net

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

Configuration
-------------------
   1. Enable the module as usual from Drupal's admin pages.
   2. Grant permissions for use of FCKeditor in Administer > User Management > Access Control
   3. Under Administer > Settings > FCKeditor, create the fckeditor profiles. 
      In each profile you can choose which textareas will be replaced by FCKeditor, 
      select default toolbar and configure some more advanced settings
   4. 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> <p> <span> <div> <h1> <h2> <h3> <h4> <h5> <h6> <img> <map> <area> <hr> 
      <br> <br /> <ul> <ol> <li> <dl> <dt> <dd> <table> <tr> <td> <em> <b> <u> <i> <strong> 
      <font> <del> <ins> <sub> <sup> <quote> <blockquote> <pre> <address> <code> 
      <cite> <embed> <object> <strike> <caption>.
   5. To have a better control over line breaks, you may disable Line break converter in the chosen filter (recommended).
   6. Modify the fckeditor.config.js file to custom your needs (optional).
      You may 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.

Installation troubleshooting
----------------------------
If your FCKeditor does not show you must check if all files are extracted correctly. 
The directory /drupal5b/modules/fckeditor/fckeditor/ should have the following files:
fckeditor.js, fckconfig.js, fckstyles.xml, fcktemplates.xml and a directory named editor.
The correct directory structure is as follows:

    modules
       fckeditor
          fckeditor.module
          fckeditor
             _samples
             editor
             COPY_HERE.txt
             fckconfig.js
             ...

Plugins: Teaser break and Pagebreak
-----------------------------------
By default, FCKeditor module comes with two plugins that can handle teaser break (<!--break-->) and pagebreak (<!--pagebreak-->). 
You can enable any (or even both) of them.

   1. Open /drupal5b/modules/fckeditor/fckeditor.config.js and uncomment these three lines:

            FCKConfig.PluginsPath = '../../plugins/' ;
            FCKConfig.Plugins.Add( 'drupalbreak' ) ;
            FCKConfig.Plugins.Add( 'drupalpagebreak' ) ;
            

   2. The second step is to add buttons to the toolbar (in the same file). 
      The button names are: DrupalBreak, DrupalPageBreak. 
      For example if you have a toolbar with an array of buttons defined as follows:

      ['Image','Flash','Table','Rule','SpecialChar']

      simply add those two buttons at the end of array:

      ['Image','Flash','Table','Rule','SpecialChar', 'DrupalBreak', 'DrupalPageBreak']

      (remember about single quotes).

Uploading images and files
--------------------------

There 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.

How to enable the file browser
------------------------------
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).

   1. To enable file browsing you need to edit the connector configuration file in your fckeditor module directory, the file should be in:

          /drupal5b/modules/fckeditor/fckeditor/editor/filemanager/connectors/php/config.php
          (FCKeditor 2.5+)

          or

          /drupal5b/modules/fckeditor/fckeditor/editor/filemanager/browser/default/connectors/php/config.php
          and
          /drupal5b/modules/fckeditor/fckeditor/editor/filemanager/upload/php/config.php
          (FCKeditor 2.3.x - 2.4.x)

      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:

          require_once "../../../../../filemanager.config.php";
          (FCKeditor 2.5+)

      or

          require_once "D:\\xampp\\htdocs\\drupal5b\\modules\\fckeditor\\filemanager.config.php"
          (FCKeditor 2.3.x - 2.4.x)

      straight below this line:

          $Config['UserFilesAbsolutePath'] = '' ;

      The config.php file also holds some other important settings, please take a look at it and adjust it to your needs (optional).
      
   2. As of Drupal 5.2, additional step is required: locate file named settings.php inside 
      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
   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.
   4. Lastly, adjust the File browser settings for each profile.

Modules: Image Assist
---------------------
Image Assist can be integrated with FCKeditor. 
To do this, simply copy the modules/fckeditor/img_assist_fckeditor.js file to modules/img_assist/img_assist_fckeditor.js.

Help & Contribution
-------------------
If you are looking for more information, have any troubles in configuration or if 
you found an issue, please visit the official project page:
  http://drupal.org/project/fckeditor

We would like to encourage you to join our team if you can help in any way.
If you can translate FCKeditor module, please use fckeditor.pot file as a template
(located in "po" directory) and send us the translated file so that we could attach it.
Any help is appreciated.
     
Credits
-------
 - FCKeditor for Drupal Core functionality originally written by:
     Frederico Caldeira Knabben
     Jorge Tite (LatPro Inc.)

 - FCKeditor for Drupal 5.x originally written by:
     Ontwerpwerk (www.ontwerpwerk.nl)
 
 - FCKeditor for Drupal 5.x is currently maintained by FCKeditor team.
     http://www.fckeditor.net/

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