coder module corrections + new pot file
[project/fckeditor.git] / TROUBLESHOOTING.txt
CommitLineData
6161740e
WW
1$Id$
2
3Note: the HTML version of this file (always up-to-date) is available online: http://drupal.fckeditor.net/troubleshooting
4
5CONTENTS OF THIS FILE
6---------------------
7
8 * FCKeditor doesn't work in xxx theme
ec304bf2 9 * Known module incompatibilities
6161740e
WW
10 * Images aren't shown when submitted
11 * I followed the instruction, but FCKeditor doesn't show up (+ debugging instructions)
12 * The FCKeditor component is not installed correctly
13 * Error loading fckstyles.xml
14 * FCKeditor doesn't work after upgrading
15 * Text alignment doesn't work
16 * Line breaks removed when editing content previously authored without using FCKeditor
17 * I successfully uploaded an image, but cannot see it in the file browser
18 * Error creating folder "redirect:/index.php/" (Can't create redirect:directory)
19 * Quote symbols being changed to quote entities
20 * FCKeditor does not appear and a Javascript warning concerning FCKLang is displayed
21
22FCKeditor doesn't work in xxx theme (150556, 158173)
23----------------------------------------------------
24
25Your theme may be missing:
26
27<?php print $scripts; ?>
28
29Add that line of code in the head section of your theme.
30The other possibility may be that:
31
32<?php print $closure; ?>
33
34is missing in your theme (solution similar as above, add that line of code to your theme at the end).
35You can also use a different theme.
36
ec304bf2
WW
37Known module incompatibilities
38------------------------------
39
40At this moment, FCKeditor will not show up, when the following modules are enabled:
41
42 * Theme developer (http://drupal.org/node/318941)
43 * Theme Builder (http://drupal.org/node/271032)
44
6161740e
WW
45Images aren't shown when submitted (175339)
46-------------------------------------------
47
48You probably must configure properly the input format. Either set it to Full HTML or add <img> tag to Filtered HTML.
49The full list of tags, which should be allowed, is available in README.txt file.
50
51I followed the instruction, but FCKeditor doesn't show up (195759, 196549)
52--------------------------------------------------------------------------
53
54First of all make sure, that FCKeditor is enabled on this specific page.
55Take a look into source code of your page and search for something similar to:
56 var oFCK_1 = new FCKeditor( 'oFCK_1' );
57 oFCK_1.BasePath = '/modules/fckeditor/fckeditor/';
58
59If you can't find similar code, then it means that FCKeditor is disabled on that page/field.
60Make sure that you have the right permissions to use FCKeditor and check your FCKeditor profile (include/exclude settings, minimum rows value).
61
62If FCKeditor is enabled, but it doesn't show up, try the following steps:
63
64 1. Switch to default theme (Garland), if FCKeditor appears, read the "FCKeditor don't work in xxx theme" instructions.
65 If your theme already has "closure" and "scripts" statements, read below.
66 2. Make sure that you're using browser compatible with FCKeditor.
67 3. On some occasions, other installed modules may cause that FCKeditor will not show up (although if you look at page source, you'll see FCKeditor code).
68 Instead of FCKeditor you may see a very small textarea.
69 This mostly happens, when some other module cause a javascript error and FCKeditor can't load because of this.
70 To check this:
71 - write down the list of currently installed modules
72 - disable all additional modules
73 - if FCKeditor showed up, start enabling all those modules that you disabled in previous step and find out which module is incompatible with FCKeditor.
74 Use the project's site to report a new bug, provide the following details:
75 * Drupal version
76 * FCKeditor module version
77 * FCKeditor version
78 * the name and version of incompatible module.
79 * if additional steps are required to reproduce this issue, like creating a new special content or configuring this additional module in a special way, then provide a detailed list of steps to follow.
80 - if the step above didn't help, disable all additional modules and switch to Garland theme, clear browser's cache.
81 If FCKeditor still doesn't work then it means that it may be corrupted.
82 Reupload FCKeditor using a FTP client that warns you when files are truncated or corrupted.
83 - if FCKeditor is working only in Garland theme with all modules enabled, but it doesn't work in your theme with all modules disabled, then your theme is a problem.
84 Use the project's site to report a new bug, provide the following details:
85 * Drupal version
86 * FCKeditor module version
87 * FCKeditor version
88 * the name and version of incompatible theme.
89 4. Finally, if nothing helped, to find out where exactly error occured, you may use Firefox with Firebug extension.
90 Use the project's site to create a new support request providing as much information as possible, including the exact javascript error message that you got.
91
92The FCKeditor component is not installed correctly (205893, 210915, 110528)
93---------------------------------------------------------------------------
94
95Please remember that installing FCKeditor module is a two step process. You have to download and unpack:
96FCKeditor module, that integrates the FCKeditor with Drupal
97FCKeditor, the HTML editor
98
99If your FCKeditor does not show you must check if all files are extracted correctly.
100The directory /modules/fckeditor/fckeditor/ should have the following files:
101fckeditor.js, fckconfig.js, fckstyles.xml, fcktemplates.xml and a directory named editor.
102
103The correct directory structure is as follows:
104modules
105 fckeditor
106 fckeditor.module
107 fckeditor
108 _samples
109 editor
110 COPY_HERE.txt
111 fckconfig.js
112 ...
113
114Error loading fckstyles.xml (233006, 210294)
115--------------------------------------------
116
117This may happen if your server is configured to parse .xml files just like .php files.
118You may need to contact your server administrator / hosting provider to get a help regarding this issue.
119You can also try to add to .htaccess file the following directive:
120AddType text/xml xml
121
122FCKeditor doesn't work after upgrading (244850)
123-----------------------------------------------
124
125This may be caused by the browser's cache. Clear your browser's cache, restart the browser if it didn't help.
126If you upgraded FCKeditor module, make sure that all roles with "access fckeditor" permissions are assigned to at least one FCKeditor profile.
127
128Text alignment doesn't work (198637)
129------------------------------------
130
131In fckeditor.config.js (located in fckeditor module directory), the following classes are defined to provide text alignment functionality:
132FCKConfig.JustifyClasses = ['rteleft','rtecenter','rteright','rtejustify'] ;
133
134Unfortunately, some themes may override those styles and text alignment may not work as expected.
135If you're using Full HTML input format, you may simply comment out this line:
136//FCKConfig.JustifyClasses = ['rteleft','rtecenter','rteright','rtejustify'] ;
137
138and FCKeditor will use inline styles instead: <p style="text-align: right;">sample text</p>.
139The problem is that inline styles may be used only with Full HTML.
140Filtered HTML will strip that code, so don't use this solution with Filtered HTML input format.
141
142For Filtered HTML things are a bit more complicated. For example if your theme defines such CSS style:
143
144.content p { text-align: left; }
145
146text-align property set in .rteright class will not work.
147To align <p> tag, you will have to edit modules/fckeditor/fckeditor.css file and create a style, that will be applied to <p> tag:
148
149.content p.rteleft {
150 text-align: left;
151}
152.content p.rteright {
153 text-align: right;
154}
155.content p.rtecenter {
156 text-align: center;
157}
158.content p.rtejustify {
159 text-align: justify;
160}
161
162Use DOM inspector (in Firefox) to check why alignment doesn't work and to correct CSS styles.
163There is no universal workaround for this.
164
165Line breaks removed when editing content previously authored without using FCKeditor (240633)
166---------------------------------------------------------------------------------------------
167
168The problems is in the way how did you configure your input filters.
169Before you enabled FCKeditor, you probably had Line break converter enabled.
170
171Now you're trying to edit the same content with Line break converter disabled, thus your linebreaks are removed.
172
173Possible workarounds:
174 * Enable Line break converter (not recommended).
175 * Create new input format with Line break converter enabled. Use it just for old articles (recommended).
176 * Start with FCKeditor disabled by default, replace all new line characters manually with <br> tag, then use toggle to switch to WYSIWYG mode.
177
178 If you're a PHP programmer, you may try the approach proposed by BakerQ in drupal.org/node/240633
179
180
181I successfully uploaded an image, but cannot see it in the file browser (239552)
182--------------------------------------------------------------------------------
183
184Well, it's probably one of the less intuitive things in FCKeditor.
185When you upload image directly through the image dialog box, "QuickUpload" command is executed. The problem is that by default, "QuickUpload" command uploads files to "root directory" of the file browser. However, when you click "browse server" button, all three resource types: "Image", "Files", "Flash" point to subdirectories inside of that directory, that's why you're not able to see uploaded files in the root directory.
186
187The solution is to edit editor/filemanager/connectors/php/config.php. Scroll down to the bottom of this file and find:
188$Config['FileTypesPath']['Image'] = $Config['UserFilesPath'] . 'image/' ;
189$Config['FileTypesAbsolutePath']['Image'] = ($Config['UserFilesAbsolutePath'] == '') ? '' : $Config['UserFilesAbsolutePath'].'image/' ;
190$Config['QuickUploadPath']['Image'] = $Config['UserFilesPath'] ;
191$Config['QuickUploadAbsolutePath']['Image']= $Config['UserFilesAbsolutePath'] ;
192
193change it to something similar to:
194$Config['FileTypesPath']['Image'] = $Config['UserFilesPath'] . 'image/' ;
195$Config['FileTypesAbsolutePath']['Image']= ($Config['UserFilesAbsolutePath'] == '') ? '' : $Config['UserFilesAbsolutePath'].'image/' ;
196$Config['QuickUploadPath']['Image'] = $Config['FileTypesPath']['Image'];
197$Config['QuickUploadAbsolutePath']['Image']= $Config['FileTypesAbsolutePath']['Image'];
198
199(apply the same change to each resource type, I've changed the last two lines)
200
201The idea is that FileTypesPath and QuickUploadPath should point to the same path (same rule applies to FileTypesAbsolutePath and QuickUploadAbsolutePath). Note that now "QuickUploadPath" points to the subdirectory, so you'll be able to see only newly uploaded files with the QuickUpload command.
202
203You can also change FileTypesPath (QuickUploadPath and so on) of each resource type so that it pointed to the "root directory" ($Config['UserFilesPath']), but this way all files will be uploaded to the same directory.
204
205Error creating folder "redirect:/index.php/" (Can't create redirect:directory) (185406)
206---------------------------------------------------------------------------------------
207
208This error appears when trying to use the built-in file browser in FCKeditor and is caused by invalid $Config['UserFilesAbsolutePath'] in FCKeditor configuration file. The reason of such message may be tricky, it usually means that you didn't follow the instructions from README.txt strictly (see "How to enable the file browser" section).
209
210Usually it is enough to check these two things:
211make sure that filemanager.config.php is included in the FCKeditor configuration file exactly in the place where the instruction says
212uncomment $cookie_domain variable in settings.php and set it to the right value
213
214Quote symbols being changed to quote entities (263426)
215------------------------------------------------------
216
217Some modules like Typogrify or SmartyPants require special handling of HTML entities.
218For example, by default, FCKeditor will convert double quote (") to &quot;.
219To disable processing HTML entities, add the following line to modules/fckeditor/fckeditor.config.js:
220
221FCKConfig.ProcessHTMLEntities = false ;
222
223It is also possible to disable processing HTML entities for selected FCKeditor profile, by adding this line in "Advanced Options" -> "Custom javascript configuration":
224
225ProcessHTMLEntities = false ;
226
227FCKeditor does not appear and a Javascript warning concerning FCKLang is displayed (190010)
228-------------------------------------------------------------------------------------------
229
230One of FCKeditors many features is its ability to detect the language of the user and load the appropriate language file.
231At first, it might tempting to leave out all language files except the one you're using when you upload FCKeditor.
232But when people using other languages are using that FCKeditor installation,
233FCKeditor will try to load a language file that isn't available and a Javascript error concerning FCKLang appears.
234Either upload back all language files or disable the "Auto-detect language" setting in your FCKeditor profile.