CKSource Docs - User contributions [en]

FCKeditor 2.x/Developers Guide/Configuration/Built in File Browser/NewFB Description

2008-04-11T09:40:13Z

W.olchawa: New page: = Built in File Browser = The editor gives the end user the flexibility to create a custom file browser that can be integrated into it or to use the default file browser provided with th...

= Built in File Browser =

The editor gives the end user the flexibility to create a custom file browser that can be integrated into it or to use the default file browser provided with the editor. This is a powerful feature because each scenario has unique requirements and the default file browser may not always meet them.Still, the editor package offers a default implementation of the File Browser so the user has a ready-to-use file browsing component, without having to develop anything.

In prior versions, a sample File Browser was available for each supported server side technology. The problem with this approach is that each sample had a different implementation and worked completely differently from one another. And worse, some of them were really poor.

To solve that problem the current version offers a '''unique user interface''' that can be used by all server side languages. The user interface was developed completely using Javascript DHTML and its integration is facilitated by XML. Doing it this way allows the developer to focus on their unique file browser requirements while not worrying about the presentation (client-side) layer.

The following graphic shows how the File Browser Integration works:

[[Image:FCKeditor FileBrowserConnector.gif|Image:FCKeditor_FileBrowserConnector.gif]]

The XML Response looks similar to this:
<pre><?xml version="1.0" encoding="utf-8" ?>
<Connector command="" resourceType="">
<CurrentFolder path="/" url="/path/to/file/" />
<Folders>
<Folder name="somefolder" />
</Folders>
<Files>
<File name="filename.jpg" size="numberOfKB" url="/path/to/file/filename.jpg" />
</Files>
</Connector>
</pre>
== Integrating the File Browser ==

In order to integrate the default File Browser into your editor you need to set the connector to use your preferred server side language. By default, configuration is set-up to use the PHP connector (in version older than 2.5 the default is ASP), but you also can choose from ASP.NET, ColdFusion, Java, Lasso, Perl, PHP and Python.

=== Version 2.2 and Higher ===

To change the default configuration open your fckconfig.js file and look for the '''FileBrowserLanguage''' and '''QuickUploadLanguage''' settings. Change the connector language to the appropriate setting.

For example, to use the PHP connector, the configuration would look like this:
<pre>var _FileBrowserLanguage = 'php' ;
var _QuickUploadLanguage = 'php' ;
</pre>
=== Enabling the connector ===

After setting the server side language for FileBrowser and QuickUpload you must remember to enable the connector. '

'''NOTE''': If you won't enable the connector the upload won't work at all.

Every server side language has its own specific connectors. They are placed in /fckeditor/editor/filemanager/connectors/(your server side language extension). Every connector has its own configuration file called config.(you server side lang extension) which allows to change several options including '''enabling'''. Below you will find information about how to enable the connector in every server side language: 

==== ASP ====

In file '''config.asp''' find the line with '''ConfigIsEnabled''' and set it to '''True'''. The code should look like this:
<pre>ConfigIsEnabled = True
</pre>
----

==== ASP.NET ====

In file '''config.ascx''' find function called '''CheckAuthentication()'''. This function should return '''true''' if the connector is to be enabled.

*For testing the connector you can just use
<pre>private bool CheckAuthentication()
{
return true;
}
</pre>
however we don't advise to use this method permanently because in this case you are "anyone" to upload and list the files in your server

*The more proper way to enable the connector is implementing some kind of session validation. Even something very simple as...
<pre> return ( Session[ "IsAuthorized" ] != null && (bool)Session[ "IsAuthorized" ] == true );
</pre>
where '''Session[ "IsAuthorized" ]''' is set to '''true''' as soon as user logs in your system.

----

==== ColdFusion ====

In file '''config.cfm''' find the line with '''Config.Enabled''' and set it to '''true'''. The code should look like this:
<pre>Config.Enabled = true ;
</pre>
----

==== Lasso ====

In file '''config.lasso''' find the line with
<pre>var('config') = map(
'Enabled' = false,
.................
.................
</pre>
and change the '''Enable''' option from false to '''true'''.

----

==== Perl ====

Perl connector is different from other connector because it doesn't have a config file. To enable the connector look for the "SECURITY" comment in the '''connector.cgi '''file and remove or comment the following line:
<pre>&SendError( 1, 'This connector is disabled. Please check the "editor/filemanager/connectors/perl/connector.cgi" file' ) ;
</pre>
----

==== PHP ====

In the file '''config.php''' find the line with '''$Config['Enabled']''' and et it to '''true'''. The code should than look like this:
<pre>$Config['Enabled'] = true ;
</pre>
----

==== Python ====

In the file '''config.py''' find the line with '''Enabled''' and set it to '''True'''. The code should look like this:
<pre>Enabled = False
</pre>
== Uploading Files ==

To upload files to the server you will also need to:

#chmod 0777 the directory you want to upload to (insecure). '''NOTE''': It is advisable to change the group ownership of the directory to the same user as apache and add group write permisions instead. 
#Set in '''$Config['UserFilesPath']''' the url relative to the web site root where the files will be stored and retrieved from the web. For example "/userfiles/" if the files are supposed to be saved and retrieved from "http://www.example.com/userfiles/". 
#You can use the '''UserFilesAbsolutePath''' setting to specify the local path for the folder where the files will be stored, and then in UserFilesPath you can use an absolute url like <nowiki>"http://www.example.com/myfiles/</nowiki>".

== Allow and deny extensions settings for filetypes ==

In editor/filemanager/connectors/(your server side language extension)/config.(extension) you can configure what extensions are allowed or denied for specific filetypes.

The filetypes you can configure are:

*Files, e.g. : 'htm', 'html', 'php', 'php3', 'php5', 'phtml', 'asp', 'aspx', 'ascx', 'jsp', 'cfm', 'cfc', 'pl', 'bat', 'exe', 'dll', 'reg', 'cgi', 'asmx'
*Images, e.g. : 'jpg', 'gif', 'jpeg', 'png'
*Flash, e.g. : 'swf'
*Media, e.g. : 'swf', 'fla', 'jpg', 'gif', 'jpeg', 'png', 'avi', 'mpg', 'mpeg'

Denying extensions will show all files except for the ones with the specified extensions, while allowing extensions will show no files except for the ones with the specified extensions. To allow all extensions for a filetype, leave both of the arrays empty for that filetype.

== Set a specific directory for each file type ==

In the current SVN and in 2.5 it will be possible to specify if each file type should use a custom folder using the '''FileTypesPath''' and '''FileTypesAbsolutePath'''. The QuickUpload folders can be controlled with '''QuickUploadPath''' and '''QuickUploadAbsolutePath'''.

For versions up to 2.4.3, if you have to integrate FCKeditor in an existing project, there may be no possibility to use the standard filebrowser folders based on the filetype: ''Image'', ''Flash'', ''Media'' and ''File''. In this case, the following comment may help you: http://sourceforge.net/tracker/index.php?func=detail&aid=1312834&group_id=75348&atid=543655

== Using the File Browser outside of FCKeditor ==

You can use the File Browser in your pages using this code as was described here: https://sourceforge.net/tracker/index.php?func=detail&aid=1369609&group_id=75348&atid=543655

Download the code (''pick.js'') and put it in your website directory. You have to include this file in the page where you want to use the File Browser in.

Example: if you put ''pick.js'' in the same directory as the file in which you refer the file browser you can put this code in your heading:
<pre><script language="JavaScript" src="pick.js" type="text/javascript"></script>
</pre>
Put a button to launch the File Browser and pass the reference to the input that will receive the selected image:
<pre><button type="button" onclick="BrowseServer('txtId');">Pick Image</button>
<input type="text" id="txtId"/>
</pre>
The only thing you will have to do is modify the path to the upload connector - it is currently set for the ASP.NET version.
<pre>// File Picker modification for FCK Editor v2.0 - www.fckeditor.net
// by: Pete Forde <pete@unspace.ca> @ Unspace Interactive
var urlobj;
function BrowseServer(obj)
{
urlobj = obj;
OpenServerBrowser(
'/FCKeditor/editor/filemanager/browser/default/browser.html?Type=Image&Connector=connectors/aspx/connector.aspx',
screen.width * 0.7,
screen.height * 0.7 ) ;
}
function OpenServerBrowser( url, width, height )
{
var iLeft = (screen.width - width) / 2 ;
var iTop = (screen.height - height) / 2 ;
var sOptions = "toolbar=no,status=no,resizable=yes,dependent=yes" ;
sOptions += ",width=" + width ;
sOptions += ",height=" + height ;
sOptions += ",left=" + iLeft ;
sOptions += ",top=" + iTop ;
var oWindow = window.open( url, "BrowseWindow", sOptions ) ;
}
function SetUrl( url, width, height, alt )
{
document.getElementById(urlobj).value = url ;
oWindow = null;
}
</pre>
E.g. if you want to use PHP as a connector instead of ASP.NET use:
<pre>'/FCKeditor/editor/filemanager/browser/default/browser.html?Type=Image&Connector=connectors/php/connector.php'
</pre>

TODO

2008-01-23T11:37:37Z

W.olchawa:

== Site ==

* <strike>Remove "index.php" from the URL.</strike>

Followed by: http://www.mediawiki.org/wiki/Manual:Short_URL/wiki.example.com/Page_title--Enabling_a_wiki_using_Apache_Rewrite

* <strike>Possibly point the root ("/") to [[Main Page|Main_Page]], redirecting the logo and the navigation box to it.</strike>

skins/MonoBook.php add in line 73:
<pre><?php $this->data['nav_urls']['mainpage']['href'] = "/"; ?></pre>
skins/MonoBook.php, line 161, replace:
<pre><?php echo htmlspecialchars($val['href']) ?></pre>
with:
<pre><?php echo ($val['href'] == "/Main_Page") ? "/" : htmlspecialchars($val['href']); ?></pre>
* <strike>Remove the PDF extension.</strike>

Commented out
<pre>require_once $IP . "/extensions/wikipdf/wikipdf.php";</pre>
in LocalSettings.php

== FCKeditor 2.x - [[FCKeditor 2.x/Users Guide|User's Guide]] ==

* <strike>Create "Introduction to the User's Guide" as the first section in the guide.</strike> (needs review) 
* <strike>Replace textual examples with screenshots.</strike> 
* <strike>In</strike>[[FCKeditor 2.x/Users Guide/Other Tasks/Spell Checking|<strike>Spell Checking</strike>]]<strike>, introduce ieSpell, explaining the the spell checker depends on the editor settings.</strike>(need review) 
* <strike>In</strike>[[FCKeditor 2.x/Users Guide/Compatibility|<strike>Compatibility</strike>]]<strike>add a section for "Incompatible Browsers", explaining what happens on those browsers intead. (need review)</strike>
* <strike>"Anchors, Links and E-Mails" should be renamed to "Links, E-Mails and Anchors" (most used first). The page structure should follow the same order.</strike> 
* <strike>Rearange the Formatting page using this order:</strike>
** <strike>Bold, italic, underlined </strike>
** <strike>Styles </strike>
** <strike>Text layout and format </strike>
** <strike>Fonts </strike>
** <strike>Size and color </strike>
** <strike>Subscript and superscript </strike>
** <strike>Templates</strike>
* <strike>Move "Templates" from</strike>[[FCKeditor 2.x/Users Guide/Common Tasks/Text Formatting|<strike>Text Formatting</strike>]]<strike>to a dedicated section</strike>. 
* <strike>In</strike>[[FCKeditor 2.x/Users Guide/Interface/Context Menu|<strike>Context Menu</strike>]]<strike>, use the standard screenshot box for the example, possibly containing a text with a link, and the context menu for the link (it's a little bit richer).</strike>
* <strike>The HTML samplein the</strike>[[FCKeditor 2.x/Users Guide/Source Editor|<strike>Source Editor</strike>]]<strike>page is wrong. The link is out of the tag. It should be This is my standard text written in the <a href="http://www.fckeditor.net">FCKeditor.</strike> 

== CKFinder - [[CKFinder/Users Guide/Configuration|Configuration]] ==

* <strike>Quick Start (enabling, license, baseUrl, baseDir)</strike>
* <strike>Access Control</strike>
* <strike>Images</strike>
** <strike>Thumbnails</strike>
** <strike>Scaling</strike>
* <strike>Resource Types</strike>
** <strike>Built-in resource types (and their relation to FCKeditor)</strike>
** <strike>Adding new resource type</strike>
* <strike>Security</strike>
** <strike>Double File Extension (Apache issue)</strike>
** <strike>Image Uploads (validating image size)</strike>
** <strike>Html Extensions (to prevent against XSS File Header injection)</strike>
* <strike>Miscelanous (actually for now in PHP only: PHP doesn't support UTF-8 natively, that's why FilesystemEncoding exists in config.php. Linux stores file names as UTF-8, so we are ok there... but on Windows we have more complicated situation. Try to upload files with chinese and polish characters. Change FilesystemEncoding to see the difference (Make sure that you have enabled iconv in php.ini - modify xampp/apache/bin/php.ini + restart Apache)). For example on my Computer (Win XP/SP2 PL), creating and deleting folder named "żółtko" is possible only with FilesystemEncoding set to CP1250.</strike>

I<strike>n the example with three roles (admin, user, guest)</strike>[[CKFinder/Developers Guide/CKFinder Configuration/PHP/Access Control|<strike>Access Control</strike>]]<strike>the default configuration should be to '''deny''' everything.</strike> 

* Actually, we have to change it. Separate function is now used to authenticate user. So default permissions to allow everything to everyone remained. We should remove the wrong examples and give instead something less complicated: All other connectors could have something similar: [[CKFinder/Developers Guide/PHP/Configuration/Access Control|Developers_Guide/PHP/Configuration/Access_Control]] 
* We should warn users about direct access to files via URL. 

* <strike>CKFinder for ASP.NET i snot anymore using an XML file for the configurations. It uses now config.ascx, so the documentation must be changed to reflect it.</strike><strike></strike>

== FCKeditor - [[FCKeditor 2.x/Developers Guide|Developers Guide]] ==

* <strike>write the descriptions of some of the configuration option left :</strike>[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options|<strike>Configuration Options</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/EditorAreaStyles|<strike>EditorAreaStyles</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/RemoveFormatTags|<strike>RemoveFormatTags</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/HtmlEncodeOutput|<strike>HtmlEncodeOutput</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/IgnoreEmptyParagraphValue|<strike>IgnoreEmptyParagraphValue</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/DisableFFTableHandles|<strike>DisableFFTableHandles</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FloatingPanelsZIndex|<strike>FloatingPanelsZIndex</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ShowDropDialog|<strike>ShowDropDialog</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ToolbarLocation|<strike>ToolbarLocation</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/AllowQueryStringDebug|<strike>AllowQueryStringDebug</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/PreloadImages|<strike>PreloadImages</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkBrowserURL|<strike>LinkBrowserURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageBrowserURL|<strike>ImageBrowserURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashBrowserURL|<strike>FlashBrowserURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkUploadURL|<strike>LinkUploadURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageUploadURL|<strike>ImageUploadURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashUploadURL|<strike>FlashUploadURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/SpellerPagesServerScript|<strike>SpellerPagesServerScript</strike>]]
* also the configuration option should be categorized
* <strike>write the Debug and Debug Object section of the</strike>[[FCKeditor 2.x/Developers Guide/Customization/Debugging|<strike>Debugging</strike>]]<strike>page</strike>
* <strike>review the guide for links that should appear in the text linking to sections which weren't build yet</strike>
** <strike>I found that in</strike>[[FCKeditor 2.x/Developers Guide/Installation/Upgrading|<strike>Upgrading</strike>]]<strike>there's a link to the SVN section. We must detrmine if the SVN section should be build or not</strike>
* actually this is more a wiki issue: some sample code can't be applied to the site because of the wiki security settings which sometimes unables to write a full example in the instruction. E.g .[[FCKeditor 2.x/Developers Guide/Integration/AFP#Handling the posted data|<strike>AFP - handling the posted data</strike>]] and [[FCKeditor 2.x/Developers Guide/Configuration/Spell Checker/Updating Aspell on Unix|Updating Aspell on Unix]]. We should work it out somehow.

TODO

2008-01-23T11:35:34Z

W.olchawa:

== Site ==

* <strike>Remove "index.php" from the URL.</strike>

Followed by: http://www.mediawiki.org/wiki/Manual:Short_URL/wiki.example.com/Page_title--Enabling_a_wiki_using_Apache_Rewrite

* <strike>Possibly point the root ("/") to [[Main Page|Main_Page]], redirecting the logo and the navigation box to it.</strike>

skins/MonoBook.php add in line 73:
<pre><?php $this->data['nav_urls']['mainpage']['href'] = "/"; ?></pre>
skins/MonoBook.php, line 161, replace:
<pre><?php echo htmlspecialchars($val['href']) ?></pre>
with:
<pre><?php echo ($val['href'] == "/Main_Page") ? "/" : htmlspecialchars($val['href']); ?></pre>
* <strike>Remove the PDF extension.</strike>

Commented out
<pre>require_once $IP . "/extensions/wikipdf/wikipdf.php";</pre>
in LocalSettings.php

== FCKeditor 2.x - [[FCKeditor 2.x/Users Guide|User's Guide]] ==

* <strike>Create "Introduction to the User's Guide" as the first section in the guide.</strike> (needs review) 
* <strike>Replace textual examples with screenshots.</strike> 
* <strike>In</strike>[[FCKeditor 2.x/Users Guide/Other Tasks/Spell Checking|<strike>Spell Checking</strike>]]<strike>, introduce ieSpell, explaining the the spell checker depends on the editor settings.</strike>(need review) 
* <strike>In</strike>[[FCKeditor 2.x/Users Guide/Compatibility|<strike>Compatibility</strike>]]<strike>add a section for "Incompatible Browsers", explaining what happens on those browsers intead. (need review)</strike>
* <strike>"Anchors, Links and E-Mails" should be renamed to "Links, E-Mails and Anchors" (most used first). The page structure should follow the same order.</strike> 
* <strike>Rearange the Formatting page using this order:</strike>
** <strike>Bold, italic, underlined </strike>
** <strike>Styles </strike>
** <strike>Text layout and format </strike>
** <strike>Fonts </strike>
** <strike>Size and color </strike>
** <strike>Subscript and superscript </strike>
** <strike>Templates</strike>
* <strike>Move "Templates" from</strike>[[FCKeditor 2.x/Users Guide/Common Tasks/Text Formatting|<strike>Text Formatting</strike>]]<strike>to a dedicated section</strike>. 
* <strike>In</strike>[[FCKeditor 2.x/Users Guide/Interface/Context Menu|<strike>Context Menu</strike>]]<strike>, use the standard screenshot box for the example, possibly containing a text with a link, and the context menu for the link (it's a little bit richer).</strike>
* <strike>The HTML samplein the</strike>[[FCKeditor 2.x/Users Guide/Source Editor|<strike>Source Editor</strike>]]<strike>page is wrong. The link is out of the tag. It should be This is my standard text written in the <a href="http://www.fckeditor.net">FCKeditor.</strike> 

== CKFinder - [[CKFinder/Users Guide/Configuration|Configuration]] ==

* <strike>Quick Start (enabling, license, baseUrl, baseDir)</strike>
* <strike>Access Control</strike>
* <strike>Images</strike>
** <strike>Thumbnails</strike>
** <strike>Scaling</strike>
* <strike>Resource Types</strike>
** <strike>Built-in resource types (and their relation to FCKeditor)</strike>
** <strike>Adding new resource type</strike>
* <strike>Security</strike>
** <strike>Double File Extension (Apache issue)</strike>
** <strike>Image Uploads (validating image size)</strike>
** <strike>Html Extensions (to prevent against XSS File Header injection)</strike>
* <strike>Miscelanous (actually for now in PHP only: PHP doesn't support UTF-8 natively, that's why FilesystemEncoding exists in config.php. Linux stores file names as UTF-8, so we are ok there... but on Windows we have more complicated situation. Try to upload files with chinese and polish characters. Change FilesystemEncoding to see the difference (Make sure that you have enabled iconv in php.ini - modify xampp/apache/bin/php.ini + restart Apache)). For example on my Computer (Win XP/SP2 PL), creating and deleting folder named "żółtko" is possible only with FilesystemEncoding set to CP1250.</strike>

I<strike>n the example with three roles (admin, user, guest)</strike>[[CKFinder/Developers Guide/CKFinder Configuration/PHP/Access Control|<strike>Access Control</strike>]]<strike>the default configuration should be to '''deny''' everything.</strike> 

* Actually, we have to change it. Separate function is now used to authenticate user. So default permissions to allow everything to everyone remained. We should remove the wrong examples and give instead something less complicated: All other connectors could have something similar: [[CKFinder/Developers Guide/PHP/Configuration/Access Control|Developers_Guide/PHP/Configuration/Access_Control]] 
* We should warn users about direct access to files via URL. 

* <strike>CKFinder for ASP.NET i snot anymore using an XML file for the configurations. It uses now config.ascx, so the documentation must be changed to reflect it.</strike><strike></strike>

== FCKeditor - [[FCKeditor 2.x/Developers Guide|Developers Guide]] ==

* <strike>write the descriptions of some of the configuration option left :</strike>[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options|<strike>Configuration Options</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/EditorAreaStyles|<strike>EditorAreaStyles</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/RemoveFormatTags|<strike>RemoveFormatTags</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/HtmlEncodeOutput|<strike>HtmlEncodeOutput</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/IgnoreEmptyParagraphValue|<strike>IgnoreEmptyParagraphValue</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/DisableFFTableHandles|<strike>DisableFFTableHandles</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FloatingPanelsZIndex|<strike>FloatingPanelsZIndex</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ShowDropDialog|<strike>ShowDropDialog</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ToolbarLocation|<strike>ToolbarLocation</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/AllowQueryStringDebug|<strike>AllowQueryStringDebug</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/PreloadImages|<strike>PreloadImages</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkBrowserURL|<strike>LinkBrowserURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageBrowserURL|<strike>ImageBrowserURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashBrowserURL|<strike>FlashBrowserURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkUploadURL|<strike>LinkUploadURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageUploadURL|<strike>ImageUploadURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashUploadURL|<strike>FlashUploadURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/SpellerPagesServerScript|<strike>SpellerPagesServerScript</strike>]]
* also the configuration option should be categorized
* write the Debug and Debug Object section of the [[FCKeditor 2.x/Developers Guide/Customization/Debugging|Debugging]] page
* <strike>review the guide for links that should appear in the text linking to sections which weren't build yet</strike>
** <strike>I found that in</strike>[[FCKeditor 2.x/Developers Guide/Installation/Upgrading|<strike>Upgrading</strike>]]<strike>there's a link to the SVN section. We must detrmine if the SVN section should be build or not</strike>
* actually this is more a wiki issue: some sample code can't be applied to the site because of the wiki security settings which sometimes unables to write a full example in the instruction. E.g.[[FCKeditor 2.x/Developers Guide/Integration/AFP#Handling the posted data|AFP - handling the posted data]]. We should work it out somehow.

File:Source example2.png

2008-01-23T11:34:04Z

W.olchawa: uploaded a new version of "Image:Source example2.png"

FCKeditor 2.x/Developers Guide/Integration/Other

2008-01-23T11:13:42Z

W.olchawa:

In this page you will find links to third party documentation regarding FCKeditor integration.

=== Blackboard ===

http://webmedia.unmc.edu/leis/mmckenzie/fck_desc.html

=== CakePHP ===

http://bakery.cakephp.org/articles/view/143

=== CodeIgniter ===

http://codeigniter.com/wiki/FCKeditor/

=== Dada Mail ===

http://mojo.skazat.com/support/documentation/Config.pm.html#fckeditor_integration___fckeditor_url

=== Drupal ===

http://drupal.org/project/fckeditor

=== JSF - MyFaces ===

[http://sourceforge.net/projects/fck-faces fck-faces]

=== Lasso ===

[http://www.nabble.com/-FCKeditor--Setup-Instructions-p8874795.html FCKEditor Setup instructions]

[http://stevepiercy.com/lasso_stuff/file_perms.lasso Permissions setup tutorial (useful for making upload work)]

=== Lotus Domino ===

https://www-10.lotus.com/ldd/nd6forum.nsf/DateAllThreadedweb/09467d31ceb6c94885257084006b57db?OpenDocument

=== Mambo ===

[http://mamboxchange.com/projects/fck/ MamboFCK]

=== Movable Type ===

http://weblog.leidenuniv.nl/users/klaassenplf/archives/2005/06/10/tutorial_wysiwyg_under_movable_type_3x.html

=== Plone ===

http://plone.org/products/fckeditor

=== Ruby on Rails ===

http://trac.underpantsgnome.com/fckeditor_on_rails - with file upload support (updated [2007-01-09] - plugin ready for Rails 1.2)

http://www.joshuamcharles.com/xhtml/fckrails.php

http://www.darknexus.org.uk/page/show/FCK_Engine

=== Smarty ===

http://www.phpinsider.com/smarty-forum/viewtopic.php?t=7861

=== SPIP ===

http://www.thierryb.net/site/-FCKeditor-pour-SPIP-.html

=== Virtual (Proxy) Filesystem in .NET ===

http://blog.pixolut.com/?s=fck+editor

=== WordPress ===

http://www.deanlee.cn/wordpress/fckeditor-for-wordpress-plugin/

FCKeditor 2.x/Developers Guide/Integration/Other

2008-01-23T11:13:25Z

W.olchawa:

TODO

2008-01-23T11:08:40Z

W.olchawa:

== Site ==

* <strike>Remove "index.php" from the URL.</strike>

Followed by: http://www.mediawiki.org/wiki/Manual:Short_URL/wiki.example.com/Page_title--Enabling_a_wiki_using_Apache_Rewrite

* <strike>Possibly point the root ("/") to [[Main Page|Main_Page]], redirecting the logo and the navigation box to it.</strike>

skins/MonoBook.php add in line 73:
<pre><?php $this->data['nav_urls']['mainpage']['href'] = "/"; ?></pre>
skins/MonoBook.php, line 161, replace:
<pre><?php echo htmlspecialchars($val['href']) ?></pre>
with:
<pre><?php echo ($val['href'] == "/Main_Page") ? "/" : htmlspecialchars($val['href']); ?></pre>
* <strike>Remove the PDF extension.</strike>

Commented out
<pre>require_once $IP . "/extensions/wikipdf/wikipdf.php";</pre>
in LocalSettings.php

== FCKeditor 2.x - [[FCKeditor 2.x/Users Guide|User's Guide]] ==

* <strike>Create "Introduction to the User's Guide" as the first section in the guide.</strike> (needs review) 
* <strike>Replace textual examples with screenshots.</strike> 
* <strike>In</strike>[[FCKeditor 2.x/Users Guide/Other Tasks/Spell Checking|<strike>Spell Checking</strike>]]<strike>, introduce ieSpell, explaining the the spell checker depends on the editor settings.</strike>(need review) 
* <strike>In</strike>[[FCKeditor 2.x/Users Guide/Compatibility|<strike>Compatibility</strike>]]<strike>add a section for "Incompatible Browsers", explaining what happens on those browsers intead. (need review)</strike>
* <strike>"Anchors, Links and E-Mails" should be renamed to "Links, E-Mails and Anchors" (most used first). The page structure should follow the same order.</strike> 
* <strike>Rearange the Formatting page using this order:</strike>
** <strike>Bold, italic, underlined </strike>
** <strike>Styles </strike>
** <strike>Text layout and format </strike>
** <strike>Fonts </strike>
** <strike>Size and color </strike>
** <strike>Subscript and superscript </strike>
** <strike>Templates</strike>
* <strike>Move "Templates" from</strike>[[FCKeditor 2.x/Users Guide/Common Tasks/Text Formatting|<strike>Text Formatting</strike>]]<strike>to a dedicated section</strike>. 
* <strike>In</strike>[[FCKeditor 2.x/Users Guide/Interface/Context Menu|<strike>Context Menu</strike>]]<strike>, use the standard screenshot box for the example, possibly containing a text with a link, and the context menu for the link (it's a little bit richer).</strike>
* The HTML samplein the [[FCKeditor 2.x/Users Guide/Source Editor|Source Editor]] page is wrong. The link is out of the tag. It should be This is my standard text written in the <a href="http://www.fckeditor.net">FCKeditor. 

== CKFinder - [[CKFinder/Users Guide/Configuration|Configuration]] ==

* <strike>Quick Start (enabling, license, baseUrl, baseDir)</strike>
* <strike>Access Control</strike>
* <strike>Images</strike>
** <strike>Thumbnails</strike>
** <strike>Scaling</strike>
* <strike>Resource Types</strike>
** <strike>Built-in resource types (and their relation to FCKeditor)</strike>
** <strike>Adding new resource type</strike>
* <strike>Security</strike>
** <strike>Double File Extension (Apache issue)</strike>
** <strike>Image Uploads (validating image size)</strike>
** <strike>Html Extensions (to prevent against XSS File Header injection)</strike>
* <strike>Miscelanous (actually for now in PHP only: PHP doesn't support UTF-8 natively, that's why FilesystemEncoding exists in config.php. Linux stores file names as UTF-8, so we are ok there... but on Windows we have more complicated situation. Try to upload files with chinese and polish characters. Change FilesystemEncoding to see the difference (Make sure that you have enabled iconv in php.ini - modify xampp/apache/bin/php.ini + restart Apache)). For example on my Computer (Win XP/SP2 PL), creating and deleting folder named "żółtko" is possible only with FilesystemEncoding set to CP1250.</strike>

I<strike>n the example with three roles (admin, user, guest)</strike>[[CKFinder/Developers Guide/CKFinder Configuration/PHP/Access Control|<strike>Access Control</strike>]]<strike>the default configuration should be to '''deny''' everything.</strike> 

* Actually, we have to change it. Separate function is now used to authenticate user. So default permissions to allow everything to everyone remained. We should remove the wrong examples and give instead something less complicated: All other connectors could have something similar: [[CKFinder/Developers Guide/PHP/Configuration/Access Control|Developers_Guide/PHP/Configuration/Access_Control]] 
* We should warn users about direct access to files via URL. 

* <strike>CKFinder for ASP.NET i snot anymore using an XML file for the configurations. It uses now config.ascx, so the documentation must be changed to reflect it.</strike><strike></strike>

== FCKeditor - [[FCKeditor 2.x/Developers Guide|Developers Guide]] ==

* <strike>write the descriptions of some of the configuration option left :</strike>[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options|<strike>Configuration Options</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/EditorAreaStyles|<strike>EditorAreaStyles</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/RemoveFormatTags|<strike>RemoveFormatTags</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/HtmlEncodeOutput|<strike>HtmlEncodeOutput</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/IgnoreEmptyParagraphValue|<strike>IgnoreEmptyParagraphValue</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/DisableFFTableHandles|<strike>DisableFFTableHandles</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FloatingPanelsZIndex|<strike>FloatingPanelsZIndex</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ShowDropDialog|<strike>ShowDropDialog</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ToolbarLocation|<strike>ToolbarLocation</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/AllowQueryStringDebug|<strike>AllowQueryStringDebug</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/PreloadImages|<strike>PreloadImages</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkBrowserURL|<strike>LinkBrowserURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageBrowserURL|<strike>ImageBrowserURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashBrowserURL|<strike>FlashBrowserURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkUploadURL|<strike>LinkUploadURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageUploadURL|<strike>ImageUploadURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashUploadURL|<strike>FlashUploadURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/SpellerPagesServerScript|<strike>SpellerPagesServerScript</strike>]]
* also the configuration option should be categorized
* write the Debug and Debug Object section of the [[FCKeditor 2.x/Developers Guide/Customization/Debugging|Debugging]] page
* <strike>review the guide for links that should appear in the text linking to sections which weren't build yet</strike>
** <strike>I found that in</strike>[[FCKeditor 2.x/Developers Guide/Installation/Upgrading|<strike>Upgrading</strike>]]<strike>there's a link to the SVN section. We must detrmine if the SVN section should be build or not</strike>
* actually this is more a wiki issue: some sample code can't be applied to the site because of the wiki security settings which sometimes unables to write a full example in the instruction. E.g.[[FCKeditor 2.x/Developers Guide/Integration/AFP#Handling the posted data|AFP - handling the posted data]]. We should work it out somehow.

CKFinder 1.x/Developers Guide/PHP/System Requirements

2008-01-23T11:03:38Z

W.olchawa:

{{Ckfinder Requirements Description}}

== Server ==

CKFinder requirments for PHP:

* PHP 4.3+ (including PHP 5.x and PHP 6.x).
* GD extension enabled (default on most installations) for thumbnails support. Thumbnails are automatically disabled if this extension is missing. See http://www.php.net/gd.

FCKeditor 2.x/Developers Guide/Troubleshooting

2008-01-23T10:57:42Z

W.olchawa:

__NOTOC__

== Troubleshooting ==

# [[#Error500|The "XML request error: Internal Server Error (500)" error message is shown when clicking the "Browse Server" button in the image and link dialogs. What is wrong?]]
# [[#LargeUpload|I'm not able to upload big files (+200Kb) using the ASP Connector? How to fix it?]]
# [[#HiddenDiv|When putting the editor in a hidden DIV on Gecko, the editor stops working. How can I solve it?]]
# [[#ClassAsp|I'm getting a Syntax Error for the Class keyword when trying to use FCKeditor with ASP. What is causing this?]]
# [[#CannotDisplay|Why do I get a "Page Cannot Be Displayed" error wherever I place the code to start the editor?]]
# [[#IEToolbar|Internet Explorer complains of a JavaScript error and no toolbar shows. Why?]]
# [[#FileBrowserIISHang|The Built In File Browser causes my IIS to stall/hang.]]
# [[#AspNetFreedScript|With ASP.NET, I'm having a "Cannot execute code in freed script" JavaScript error.]]
# [[#SpellerPages|After configuring Speller Pages, Internet Explorer gives strange script errors.]]
# [[#FFToolbar|Firefox was not loading my toolbars if I used the default set, but it was working for basic.]]
# [[#CopyPasteSecurity|Security warning when using toolbar or context menu cut/copy/paste commands. How to enable them to work properly?]]
# [[#GeckoPopups|Blank popups (e.g. from Source button) with Gecko browsers (!SeaMonkey, Firefox, ...)]]
# [[#DomDocument|The toolbar doesn't load in Firefox and I get an error message in the console: this.DOMDocument has no properties]]
# [[#AjaxSubmit|The editor's content is empty when submitting the editor's surrounding form by ajax. What is wrong?]]
# [[#AspUpdatePanel|The editor's content is empty inside an ASP.NET AJAX UpdatePanel]]
# [[#JSDisabled|There is just an empty Field, when JavaScript is disabled. What is wrong?]]
# [[#AspRequiredField|With ASP.NET, I need to submit twice when using the RequiredFieldValidator in a FCKeditor instance]]
# [[#IloFullSrc|Strange attribute named "ilo-full-src" on images when working with Firefox]]
# [[#FFPanels|The panels containing font styles, size, color etc are incorrectly positioned when they appear in Firefox]]
# [[#IETableBorders|The showborders option isn't working on IE so that tables with border=0 are invisible in the edit window]]

=== The "XML request error: Internal Server Error (500)" error message is shown when clicking the "Browse Server" button in the image and link dialogs. What is wrong? ===

You probably don't have the correct "Connector" for your server language set in the '''fckconfig.js''' file. By default, it uses the ASP connector. For more info about it, please click [[FCKeditor 2.x/Developers Guide/Configuration/Built in File Browser|here]].

Or you have a not correct configuration of parameter ConfigUserFilesPath = "/folder_for_userfiles/" in the config.asp file located in the folder \FCKeditor\editor\filemanager\browser\default\connectors\asp

For CF MX6+ you must also have an application.cfm with a <cfapplication name="blah"> tag somewhere above FCKeditor so that application variables are enabled. FCK requires that.

=== I'm not able to upload big files (+200Kb) using the ASP Connector? How to fix it? ===

IIS6.0 prevents the upload of files bigger than +200Kb. So you need to make some changes in the default IIS settings first.

Background: For IIS6.0 users, the AspMaxRequestEntityAllowed property specifies the maximum number of bytes allowed in the entity body of an ASP request. If a Content-Length header is present and specifies an amount of data greater than the value of AspMaxRequestEntityAllowed, IIS returns a 403 error response.

This property is related in function to MaxRequestEntityAllowed, but is specific to ASP request. Whereas you might set the MaxRequestEntityAllowed property to 1 MB at the general World Wide Web Publishing Service (WWW Service) level, you may choose to set AspMaxRequestEntityAllowed to a lower value, if you know that your specific ASP applications handle a smaller amount of data.

Solution: Open your metabase.XML which is located in c:\Windows\System32\Inetsrv find the line "AspMaxRequestEntityAllowed" and change it to "1073741824". This is 1GB - of course you can enter another value to suite your needs.

=== When putting the editor in a hidden DIV on Gecko, the editor stops working. How can I solve it? ===

This is a Gecko specific bug. A sample workaround can be found in the "_testcases" folder. Take a look at the "004.html" file.You just need to "re-enable" the editing when you make the DIV visible.

''Edited by Alexander Kerkum - May 31, 2006''

You can use this function to enable/disable all fckeditors in a given div:
<pre>if (!document.all) {switchEditors(document.getElementById("div_id_here"),"on");}
function switchEditors(oNode,sType)
{
var i=0;
for (i=0;i<oNode.childNodes.length;i++)
{
childNode = oNode.childNodes.item(i);
editor = FCKeditorAPI.GetInstance(childNode.name);
if (editor && editor.EditorDocument && editor.EditMode == FCK_EDITMODE_WYSIWYG)
{
editor.EditorDocument.designMode = sType;
}
switchEditors(childNode,sType);
}
}

</pre>
''Edited by Ian Sullivan - 8/11/05''

This doesn't seem to work anymore. If I open 004.html, hide, and then show the editor I can't edit. A thread in the [http://www.fckeditor.net/forums/ forums] noted that hiding the iframe causes Geko to turn off designMode so you just need to turn it back on when you make it visible.
<pre>if (!document.all){ //Check for Gecko
var editor = FCKeditorAPI.GetInstance(kArticleRTE);
//This test is probably overcautious, but since
//EditorDocument isn't available with an accessor
//it could disappear in a future release.
if (editor && editor.EditorDocument && editor.EditMode == FCK_EDITMODE_WYSIWYG){
editor.EditorDocument.designMode = "on";
}
}
</pre>
''Edited by Colin Ramsay - 15/08/2005''

We managed to solve this issue. Firstly make sure the code which hides your div is *not* attached to the onload event. I put it inline after the FCKEditor. Secondly, when you go to show the editor again, do something like this:
<pre>function designModeOn(){
var editor = FCKeditorAPI.GetInstance('FCKeditor1');
editor.EditorDocument.designMode = "on";
}
function hide(){
var container = document.getElementById('container');
container.style.display = 'none'
}
function show(){
var container = document.getElementById('container');
container.style.display = 'block';
}
function doShow(){
show();
hide();
show();
designModeOn();
}
doShow();
</pre>
In other words, show it, then hide it, then show it again. Then activate design mode.

''Update by Christian Springub - 22 may 2006''

These solutions works only under FireFox. I found the same problem also in Internet Explorer. In this browser when you show your hidden div you can write text in editor but you can't format it. I modified the first code and this is the effect:
<pre>function switchEditors(oNode) {
var i=0;
for (i=0;i<oNode.childNodes.length;i++) {
childNode = oNode.childNodes.item(i);
editor = FCKeditorAPI.GetInstance(childNode.name);
if (editor && editor.EditorDocument && editor.EditMode == FCK_EDITMODE_WYSIWYG) {
editor.SwitchEditMode();
editor.SwitchEditMode();
}
switchEditors(childNode);
}
}
</pre>
and in the function which shows your div put this command:
<pre>switchEditors(document.getElementById('id of div'));
</pre>
This function simply turn editor in source-code mode and then come back into design mode.

''Added by Wojciech Małota ( [http://www.php-art.eu/ CMS] ) - 24 Jun 2006''

I couldn't get the above working. Childnode.name wasn't working. I think Childnode.id might have. Anyway, I recoded it using prototype.js wizardry. It works for me. Haven't tested in IE yet though.
<pre>function switchEditors() {
$$('textarea').each(function(ta) {
editor = FCKeditorAPI.GetInstance(ta.id);
if (editor && editor.EditorDocument && editor.EditMode == FCK_EDITMODE_WYSIWYG) {
editor.SwitchEditMode()
editor.SwitchEditMode()
}
})
}
</pre>
''Added by Matt C - 27 Jun 2006''

This is the answer for Matt's text.

I've tested my code in latest release versions of IE, Opera and FireFox and there is no problem. The only one thing I found is that there is an error if script shows a hidden div (and executes the function which enables the editor) before the FCKEditor is loaded. I present here the solution of this bug. I hope all people will understand how it works so I don't have to describe it.
<pre>var FCKeditorLoaded = false;
function FCKeditor_OnComplete(editorInstance) {
FCKeditorLoaded = true;
}
function switchEditors(ID) {
if(!FCKeditorLoaded) {
setTimeout('switchEditors(\'' + ID + '\')', 500);
return;
}
DoSwitchEditors(document.getElementById(ID));
}
function DoSwitchEditors(oNode) {
var i;
for (i = 0; i < oNode.childNodes.length;i++) {
childNode = oNode.childNodes.item(i);
editor = FCKeditorAPI.GetInstance(childNode.name);
if (editor && editor.EditorDocument && editor.EditMode == FCK_EDITMODE_WYSIWYG) {
editor.SwitchEditMode();
editor.SwitchEditMode();
}
DoSwitchEditors(childNode);
}
}
</pre>
To start the work you need to execute this:
<pre>switchEditors('id of element');
</pre>
''Added by Wojciech Małota ( [http://www.php-art.eu/ CMS] ) - 28 Jun 2006''

The problem seems to be solved in FCK Version 2.3 and Firefox 1.5.0.3. In Firefox Version 1.03 the problem exists furthermore.

''Added by Luis Rocha ( ludwig_von_rocht@yahoo.com ) - 20 Mar 2007''

am using the latest version of FCK on Firefox 2.0 on both Mac and Windows Vista, the problem appears on both, but not on IE7. The editors are in a hidden div and when I get to a step in the application process it shows the editors' div, but when I click on the editor field it doesn't receive focus. What I do is hit the Source button twice and it allows me to focus after that.

=== I'm getting a Syntax Error for the Class keyword when trying to use FCKeditor with ASP. What is causing this? ===

I'm getting a Syntax Error for the Class keyword when trying to use FCKeditor with ASP. What is causing this?

Make sure that the include statement for the fckeditor.asp file is before all other code on your page. If you are using the editor on another included page, make sure the fckeditor.asp include is at the top of the parent page.

=== Why do I get a "Page Cannot Be Displayed" error wherever I place the code to start the editor? ===

This can be caused because your code is not pointing the editor to the directory where the editor core (the main JavaScript file of the editor) has been installed on your server.

By default, the editor is configured to work in the "FCKeditor" folder at you web site root. You can easily change it by setting the BasePath property in your code when creating an instance of the editor. This is a sample code for ASP:
<pre><%
oFCKeditor.BasePath = "/fckeditor/"
%>
</pre>
=== Internet Explorer complains of a JavaScript error and no toolbar shows. Why? ===

Possibly check in your configuration file '''fckconfig.js''' for errors. The custom toolbar setting line labeled '''FCKConfig.ToolbarSets[ "Default" ]''' is a common place to have an error. An extra comma is the most probable problem.
<pre>FCKConfig.ToolbarSets["Default"] = [
['Source','-','Save','NewPage','Preview'],
...
['Style','FontFormat','FontName','FontSize'],
] ;
</pre>
Should be:
<pre>FCKConfig.ToolbarSets["Default"] = [
['Source','-','Save','NewPage','Preview'],
...
['Style','FontFormat','FontName','FontSize']
] ;
</pre>
=== The Built In File Browser causes my IIS to stall/hang. ===

If you are developing a project on a server with McAfee Antivirus software running, chances are good that the problem lies in part with the antivirus software. Try disabling ScriptStopper. ScriptStopper is trying to protect your computer from malicious scripts that will access your file system. Do not forget to re-enable ScriptStopper once you are finished.

For information on enabling/disabling ScriptStopper, see your help files or McAfee's online documentation.

This same problem *may* be true for Norton Antivirus, but I have not tested with that.

=== With ASP.Net, I'm having a "Cannot execute code in freed script" JavaScript error. ===

Try to turn off SmartNavigation.

=== After configuring Speller Pages, Internet Explorer gives strange script errors. ===

Make sure your server is not running PHP in safe mode. The Speller Pages spell checker needs to be able to run the shell_exec() PHP function, which is disabled in safe mode.

=== Firefox was not loading my toolbars if I used the default set, but it was working for basic. ===

I found that there were certain buttons that caused problems Style, Font Format/Size/Face, Text Color/BGColor.

I finally figured out that this had to do with the mime type that my server was sending, so I added the following line to my .htaccess:
<pre>AddType text/xml .xml
</pre>
This resolved the problem of displaying, but it turned out that was only part of the problem. It turned out that after I got the toolbars displayed, that FCKeditor never fully loaded - the progress bar was stuck almost all the way done and my memory usage was increasing slowly.

I resolved this problem with the following in my .htaccess file:
<pre><FilesMatch "\.html$">
ForceType none
</FilesMatch>
<FilesMatch "\.htm$">
ForceType none
</FilesMatch>
</pre>
Like a lot of webmasters, I'm doing some funky stuff with mod_rewrite, parsing html as php, etc. It turned out that the things I was doing in my root directory were not compatible with FCKeditor.

In the end, this is what my /FCKeditor/.htaccess file looks like:
<pre>AddType application/x-javascript .js
AddType text/css .css
AddType text/xml .xml
<FilesMatch "\.html$">
ForceType none
</FilesMatch>
<FilesMatch "\.htm$">
ForceType none
</FilesMatch>
</pre>
The first two lines (having to do with .js and .css) I picked up from the htaccess.txt file as a troubleshooting step.

=== Security warning when using toolbar or context menu cut/copy/paste commands. How to enable them to work properly? ===

Firefox has very rigid security features that blocks script based application, like FCKeditor, to have access to the computer clipboard. So, when using this browser, it is quite common to see a warning like the following when clicking in the “Cut” button on the toolbar:

''"Your browser security settings don’t permit the editor to automatically execute cutting operations. Please use the keyboard for that (Ctrl+X)"''

There are ways to configure Firefox, granting the necessary permissions to FCKeditor to make pasting operations. Detailed info can be found here: http://kb.mozillazine.org/Granting_JavaScript_access_to_the_clipboard

To make the configurations easy and very intuitive (integrated with the FCKeditor interface), I recommend the following extension: http://allowclipboard.foxinus.cz/

=== Blank popups (e.g. from Source button) with Gecko browsers (!SeaMonkey, Firefox, ...) ===

It must have been some extension which set the preference '''capability.policy.default.Window.resizeTo''' to the value '''noAccess'''. The preference does not appear in about:config, so it's even harder to detect. I found it by going through prefs.js (located in the folder of the respective profile).

=== The toolbar doesn't load in Firefox and I get an error message in the console: this.DOMDocument has no properties ===

This problem is usually due to your server doesn't returning the proper MIME type for the .xml files (fck_styles.xml). You can verify that removing the styles combo from the toolbar and loading again the editor (after clearing the cache) fixes the problem.

The problem can be due to different reasons at the server side:

* Mime type not configured for .xml files, can be solved in Apache by putting a .htaccess file into the base directory with the following:
<pre>Addtype text/xml .xml
</pre>
* Restriction to use .xml files due to security concerns. You'll need to set up another extension as text/xml and use that or use a dinamic page with the proper content type.

'''NOTE''': It should be better if the editor was coded to handle this error and show a warning message instead of silently failing.

=== The editor's content is empty when submitting the editor's surrounding form by ajax. What is wrong? ===

This problem is caused by a missing call of the function '''FCK.UpdateLinkedField()'''. By submitting the editor's surrounding form with an ajax function the values of all form elements are collected in a javascript object (some kind of an array). At this time the value of the hidden field that usually contains the editor's html output is empty, because the editor's surrounding form wasn't submitted for real, you can call it a simulated submit. The workaround is to call the FCK.UpdateLinkedField() function before submitting the form. Either you call it directly before the ajax collect function or in the onClick attribute of the submit button. For general use, even if you have more than one FCKeditor instance, I wrote the following hack to solve the problem.
<pre>// Some Class
function MyClass()
{
this.UpdateEditorFormValue = function()
{
for ( i = 0; i < parent.frames.length; ++i )
if ( parent.frames[i].FCK )
parent.frames[i].FCK.UpdateLinkedField();
}
}
// instantiate the class
var MyObject = new MyClass();
</pre>
Now can call this method in the onSubmit attribute of the editor's surrounding form before calling the ajax collecting function:
<pre><form ... onSubmit="MyObject.UpdateEditorFormValue(); Ajax.Collect(); return false;">
</pre>
'''NOTE''': the previous syntax won't work if using VisualStudio 2005 and Atlas and IE. It will be ok to use:
<pre><form ... onSubmit="MyObject.UpdateEditorFormValue(); return true;">
</pre>
Or you'll do it in the onClick attribute of the submit button, which is also called before the onSubmit event: <input type="submit" ... onClick="MyObject.UpdateEditorFormValue();" /> ''Edited by heiligkind ( hollo@heiligkind.de ) 17 August 2006''

A german version can be found at: http://blog.heiligkind.de/category/nutzliches/

=== The editor's content is empty inside an ASP.NET AJAX UpdatePanel ===

If you have trouble getting FCKeditor's '.Value' inside an ASP.NET AJAX UpdatePanel try registering your submit button for a full postback.

Declaratively:
<pre><asp:ScriptManager ID="ScriptManager1" runat="server"/>
<asp:UpdatePanel ID="UpdatePanel1" UpdateMode="Conditional" runat="server">
<ContentTemplate>
<FCKeditorV2:FCKeditor id="Editor1" BasePath="~/Resources/FCKeditor/" runat="server" />
<asp:Button runat="server" Text="Button1" OnClick="Button1_click"></asp:Button>
</ContentTemplate>
<Triggers>
<asp:PostBackTrigger ControlID="Button1" />
</Triggers>
</asp:UpdatePanel>
</pre>
Or in CodeBehind:
<pre>protected void Page_Load(object sender, EventArgs e) {
ScriptManager1.RegisterPostBackControl(Button1);
}
</pre>
=== There is just an empty Field, when JavaScript is disabled. What is wrong? ===

This problem is caused by a missing fallback implementation in the PHP method FCKeditor::createHTML(). Even if '''JavaScript''' is disabled this function returns an output to display the FCKeditor's IFrame, which only works if JavaScript is enabled. Infact you're not able to get information in PHP if JavaScript is enabled or not, so we have to do a little workaround for a fallback by using the good old [noscript] tag. To keep the FCKeditor's files updatable, it's recommanded to extend the main class. And this is, how it works:
<pre>// include FCKeditor's main class
require_once 'fckeditor/fckeditor.php';
/**
* extended class MyFCKeditor
*/
class MyFCKeditor extends FCKeditor
{
/**
* returns the Editor's HTML output
*/
public function returnEditor()
{
// create plaintext, if JavaScript is disabled
// replace / by "\n"
$noscript_value = str_replace( ' ', "\n", $this->Value );
$noscript_value = str_replace( ' ', "\n", $this->Value );
// remove all tags (could be HTML content)
$noscript_value = strip_tags( $noscript_value );
// remove tabs (probably createt by HTML formatting)
$noscript_value = str_replace( "\t", "", $noscript_value );
// set the width of the textarea
$noscript_width = strpos( $this->Width, '%' ) ? $this->Width : $this->Width . 'px';
// create return string
$returner = '<script langauge="JavaScript1.2" type="text/javascript">';
// JavaScript is enabled
$returner .= "document.write('";
// "\n" entfernen, da sonst ein JavaScript Fehler entsteht
$returner .= str_replace( "\n", "", $this->CreateHtml() );
$returner .= "');</script>";
// JavaScript is disabled
$returner .= '<noscript>';
$returner .= '<textarea name="' . $this->InstanceName . '" ';
$returner .= 'style="width:' . $noscript_width . ';';
$returner .= 'height:' . $this->Height . 'px;">';
$returner .= $noscript_value . '</textarea>';
$returner .= '</noscript>';
// return
return $returner;
}
}
// Initialize a new editor instance
$editor = new MyFCKeditor();
$editor->Height = '100';
$editor->Width = '100%'
$editor->Value = 'Hallo, das ist ein dicker Text!';
// print the editor's code
echo $editor->returnEditor();
</pre>
Now, if JavaScript is enabled the FCKeditor is displayed as usual, otherwie ther will be a textarea.

''Edited by heiligkind ( hollo@heiligkind.de ) 17 August 2006''

A german version can be found at:http://blog.heiligkind.de/category/nutzliches/

=== With ASP.NET, I need to submit twice when using the RequiredFieldValidator in a FCKeditor instance ===

FCKeditor will not work properly with the Required Field Validator when the "EnableClientScript" property of the validator is set to "true" (default). Due to a limitation in the default validation system, you must set it to "false".

If you want to do client side validation, you must use a Custom Validator instead and provide the appropriate validation function, using the FCKeditor JavaScript API.

=== Strange attribute named "ilo-full-src" on images when working with Firefox ===

It may happen if you have the "ImgLikeOpera" extension installed. Just disable it and everything will work fine.

=== The panels containing font styles, size, color etc are incorrectly positioned when they appear in Firefox ===

Try wrapping your <textarea></textarea> tags in a div with position set to 'relative'. Like so:
<pre><div style="position: relative;"><textarea id="myTextArea"></textarea></div>
</pre>
=== The showborders option isn't working on IE so that tables with border=0 are invisible in the edit window ===

IE support for this option is provided via a .htc behavior. On my server, however, the mime-type for .htc files was not set correctly and so IE was not using them (see the Microsoft Knowledge Base article at http://support.microsoft.com/kb/306231). Adding the line:
<pre>AddType text/x-component .htc
</pre>
to my .htaccess file resolved this problem.

FCKeditor 2.x/Developers Guide/Troubleshooting

2008-01-23T10:56:53Z

W.olchawa:

__NOTOC__

== Troubleshooting ==

# [[#Error500|The "XML request error: Internal Server Error (500)" error message is shown when clicking the "Browse Server" button in the image and link dialogs. What is wrong?]]
# [[#LargeUpload|I'm not able to upload big files (+200Kb) using the ASP Connector? How to fix it?]]
# [[#HiddenDiv|When putting the editor in a hidden DIV on Gecko, the editor stops working. How can I solve it?]]
# [[#ClassAsp|I'm getting a Syntax Error for the Class keyword when trying to use FCKeditor with ASP. What is causing this?]]
# [[#CannotDisplay|Why do I get a "Page Cannot Be Displayed" error wherever I place the code to start the editor?]]
# [[#IEToolbar|Internet Explorer complains of a JavaScript error and no toolbar shows. Why?]]
# [[#FileBrowserIISHang|The Built In File Browser causes my IIS to stall/hang.]]
# [[#AspNetFreedScript|With ASP.NET, I'm having a "Cannot execute code in freed script" JavaScript error.]]
# [[#SpellerPages|After configuring Speller Pages, Internet Explorer gives strange script errors.]]
# [[#FFToolbar|Firefox was not loading my toolbars if I used the default set, but it was working for basic.]]
# [[#CopyPasteSecurity|Security warning when using toolbar or context menu cut/copy/paste commands. How to enable them to work properly?]]
# [[#GeckoPopups|Blank popups (e.g. from Source button) with Gecko browsers (!SeaMonkey, Firefox, ...)]]
# [[#DomDocument|The toolbar doesn't load in Firefox and I get an error message in the console: this.DOMDocument has no properties]]
# [[#AjaxSubmit|The editor's content is empty when submitting the editor's surrounding form by ajax. What is wrong?]]
# [[#AspUpdatePanel|The editor's content is empty inside an ASP.NET AJAX UpdatePanel]]
# [[#JSDisabled|There is just an empty Field, when JavaScript is disabled. What is wrong?]]
# [[#AspRequiredField|With ASP.NET, I need to submit twice when using the RequiredFieldValidator in a FCKeditor instance]]
# [[#IloFullSrc|Strange attribute named "ilo-full-src" on images when working with Firefox]]
# [[#FFPanels|The panels containing font styles, size, color etc are incorrectly positioned when they appear in Firefox]]
# [[#IETableBorders|The showborders option isn't working on IE so that tables with border=0 are invisible in the edit window]]

=== The "XML request error: Internal Server Error (500)" error message is shown when clicking the "Browse Server" button in the image and link dialogs. What is wrong? ===

You probably don't have the correct "Connector" for your server language set in the '''fckconfig.js''' file. By default, it uses the ASP connector. For more info about it, please click [[FCKeditor 2.x/Developers Guide/Configuration/Built in File Browser|here]].

Or you have a not correct configuration of parameter ConfigUserFilesPath = "/folder_for_userfiles/" in the config.asp file located in the folder \FCKeditor\editor\filemanager\browser\default\connectors\asp

For CF MX6+ you must also have an application.cfm with a <cfapplication name="blah"> tag somewhere above FCKeditor so that application variables are enabled. FCK requires that.

=== I'm not able to upload big files (+200Kb) using the ASP Connector? How to fix it? ===

IIS6.0 prevents the upload of files bigger than +200Kb. So you need to make some changes in the default IIS settings first.

Background: For IIS6.0 users, the AspMaxRequestEntityAllowed property specifies the maximum number of bytes allowed in the entity body of an ASP request. If a Content-Length header is present and specifies an amount of data greater than the value of AspMaxRequestEntityAllowed, IIS returns a 403 error response.

This property is related in function to MaxRequestEntityAllowed, but is specific to ASP request. Whereas you might set the MaxRequestEntityAllowed property to 1 MB at the general World Wide Web Publishing Service (WWW Service) level, you may choose to set AspMaxRequestEntityAllowed to a lower value, if you know that your specific ASP applications handle a smaller amount of data.

Solution: Open your metabase.XML which is located in c:\Windows\System32\Inetsrv find the line "AspMaxRequestEntityAllowed" and change it to "1073741824". This is 1GB - of course you can enter another value to suite your needs.

=== When putting the editor in a hidden DIV on Gecko, the editor stops working. How can I solve it? ===

This is a Gecko specific bug. A sample workaround can be found in the "_testcases" folder. Take a look at the "004.html" file.You just need to "re-enable" the editing when you make the DIV visible.

''Edited by Alexander Kerkum - May 31, 2006''

You can use this function to enable/disable all fckeditors in a given div:
<pre>if (!document.all) {switchEditors(document.getElementById("div_id_here"),"on");}
function switchEditors(oNode,sType)
{
var i=0;
for (i=0;i<oNode.childNodes.length;i++)
{
childNode = oNode.childNodes.item(i);
editor = FCKeditorAPI.GetInstance(childNode.name);
if (editor && editor.EditorDocument && editor.EditMode == FCK_EDITMODE_WYSIWYG)
{
editor.EditorDocument.designMode = sType;
}
switchEditors(childNode,sType);
}
}

</pre>
''Edited by Ian Sullivan - 8/11/05''

This doesn't seem to work anymore. If I open 004.html, hide, and then show the editor I can't edit. A thread in the [http://www.fckeditor.net/forums/ forums] noted that hiding the iframe causes Geko to turn off designMode so you just need to turn it back on when you make it visible.
<pre>if (!document.all){ //Check for Gecko
var editor = FCKeditorAPI.GetInstance(kArticleRTE);
//This test is probably overcautious, but since
//EditorDocument isn't available with an accessor
//it could disappear in a future release.
if (editor && editor.EditorDocument && editor.EditMode == FCK_EDITMODE_WYSIWYG){
editor.EditorDocument.designMode = "on";
}
}
</pre>
''Edited by Colin Ramsay - 15/08/2005''

We managed to solve this issue. Firstly make sure the code which hides your div is *not* attached to the onload event. I put it inline after the FCKEditor. Secondly, when you go to show the editor again, do something like this:
<pre>function designModeOn(){
var editor = FCKeditorAPI.GetInstance('FCKeditor1');
editor.EditorDocument.designMode = "on";
}
function hide(){
var container = document.getElementById('container');
container.style.display = 'none'
}
function show(){
var container = document.getElementById('container');
container.style.display = 'block';
}
function doShow(){
show();
hide();
show();
designModeOn();
}
doShow();
</pre>
In other words, show it, then hide it, then show it again. Then activate design mode.

''Update by Christian Springub - 22 may 2006''

These solutions works only under FireFox. I found the same problem also in Internet Explorer. In this browser when you show your hidden div you can write text in editor but you can't format it. I modified the first code and this is the effect:
<pre>function switchEditors(oNode) {
var i=0;
for (i=0;i<oNode.childNodes.length;i++) {
childNode = oNode.childNodes.item(i);
editor = FCKeditorAPI.GetInstance(childNode.name);
if (editor && editor.EditorDocument && editor.EditMode == FCK_EDITMODE_WYSIWYG) {
editor.SwitchEditMode();
editor.SwitchEditMode();
}
switchEditors(childNode);
}
}
</pre>
and in the function which shows your div put this command:
<pre>switchEditors(document.getElementById('id of div'));
</pre>
This function simply turn editor in source-code mode and then come back into design mode.

''Added by Wojciech Małota ( [http://www.php-art.eu/: CMS] ) - 24 Jun 2006''

I couldn't get the above working. Childnode.name wasn't working. I think Childnode.id might have. Anyway, I recoded it using prototype.js wizardry. It works for me. Haven't tested in IE yet though.
<pre>function switchEditors() {
$$('textarea').each(function(ta) {
editor = FCKeditorAPI.GetInstance(ta.id);
if (editor && editor.EditorDocument && editor.EditMode == FCK_EDITMODE_WYSIWYG) {
editor.SwitchEditMode()
editor.SwitchEditMode()
}
})
}
</pre>
''Added by Matt C - 27 Jun 2006''

This is the answer for Matt's text.

I've tested my code in latest release versions of IE, Opera and FireFox and there is no problem. The only one thing I found is that there is an error if script shows a hidden div (and executes the function which enables the editor) before the FCKEditor is loaded. I present here the solution of this bug. I hope all people will understand how it works so I don't have to describe it.
<pre>var FCKeditorLoaded = false;
function FCKeditor_OnComplete(editorInstance) {
FCKeditorLoaded = true;
}
function switchEditors(ID) {
if(!FCKeditorLoaded) {
setTimeout('switchEditors(\'' + ID + '\')', 500);
return;
}
DoSwitchEditors(document.getElementById(ID));
}
function DoSwitchEditors(oNode) {
var i;
for (i = 0; i < oNode.childNodes.length;i++) {
childNode = oNode.childNodes.item(i);
editor = FCKeditorAPI.GetInstance(childNode.name);
if (editor && editor.EditorDocument && editor.EditMode == FCK_EDITMODE_WYSIWYG) {
editor.SwitchEditMode();
editor.SwitchEditMode();
}
DoSwitchEditors(childNode);
}
}
</pre>
To start the work you need to execute this:
<pre>switchEditors('id of element');
</pre>
''Added by Wojciech Małota ( [http://www.php-art.eu/: CMS] ) - 28 Jun 2006''

The problem seems to be solved in FCK Version 2.3 and Firefox 1.5.0.3. In Firefox Version 1.03 the problem exists furthermore.

''Added by Luis Rocha ( ludwig_von_rocht@yahoo.com ) - 20 Mar 2007''

am using the latest version of FCK on Firefox 2.0 on both Mac and Windows Vista, the problem appears on both, but not on IE7. The editors are in a hidden div and when I get to a step in the application process it shows the editors' div, but when I click on the editor field it doesn't receive focus. What I do is hit the Source button twice and it allows me to focus after that.

=== I'm getting a Syntax Error for the Class keyword when trying to use FCKeditor with ASP. What is causing this? ===

I'm getting a Syntax Error for the Class keyword when trying to use FCKeditor with ASP. What is causing this?

Make sure that the include statement for the fckeditor.asp file is before all other code on your page. If you are using the editor on another included page, make sure the fckeditor.asp include is at the top of the parent page.

=== Why do I get a "Page Cannot Be Displayed" error wherever I place the code to start the editor? ===

This can be caused because your code is not pointing the editor to the directory where the editor core (the main JavaScript file of the editor) has been installed on your server.

By default, the editor is configured to work in the "FCKeditor" folder at you web site root. You can easily change it by setting the BasePath property in your code when creating an instance of the editor. This is a sample code for ASP:
<pre><%
oFCKeditor.BasePath = "/fckeditor/"
%>
</pre>
=== Internet Explorer complains of a JavaScript error and no toolbar shows. Why? ===

Possibly check in your configuration file '''fckconfig.js''' for errors. The custom toolbar setting line labeled '''FCKConfig.ToolbarSets[ "Default" ]''' is a common place to have an error. An extra comma is the most probable problem.
<pre>FCKConfig.ToolbarSets["Default"] = [
['Source','-','Save','NewPage','Preview'],
...
['Style','FontFormat','FontName','FontSize'],
] ;
</pre>
Should be:
<pre>FCKConfig.ToolbarSets["Default"] = [
['Source','-','Save','NewPage','Preview'],
...
['Style','FontFormat','FontName','FontSize']
] ;
</pre>
=== The Built In File Browser causes my IIS to stall/hang. ===

If you are developing a project on a server with McAfee Antivirus software running, chances are good that the problem lies in part with the antivirus software. Try disabling ScriptStopper. ScriptStopper is trying to protect your computer from malicious scripts that will access your file system. Do not forget to re-enable ScriptStopper once you are finished.

For information on enabling/disabling ScriptStopper, see your help files or McAfee's online documentation.

This same problem *may* be true for Norton Antivirus, but I have not tested with that.

=== With ASP.Net, I'm having a "Cannot execute code in freed script" JavaScript error. ===

Try to turn off SmartNavigation.

=== After configuring Speller Pages, Internet Explorer gives strange script errors. ===

Make sure your server is not running PHP in safe mode. The Speller Pages spell checker needs to be able to run the shell_exec() PHP function, which is disabled in safe mode.

=== Firefox was not loading my toolbars if I used the default set, but it was working for basic. ===

I found that there were certain buttons that caused problems Style, Font Format/Size/Face, Text Color/BGColor.

I finally figured out that this had to do with the mime type that my server was sending, so I added the following line to my .htaccess:
<pre>AddType text/xml .xml
</pre>
This resolved the problem of displaying, but it turned out that was only part of the problem. It turned out that after I got the toolbars displayed, that FCKeditor never fully loaded - the progress bar was stuck almost all the way done and my memory usage was increasing slowly.

I resolved this problem with the following in my .htaccess file:
<pre><FilesMatch "\.html$">
ForceType none
</FilesMatch>
<FilesMatch "\.htm$">
ForceType none
</FilesMatch>
</pre>
Like a lot of webmasters, I'm doing some funky stuff with mod_rewrite, parsing html as php, etc. It turned out that the things I was doing in my root directory were not compatible with FCKeditor.

In the end, this is what my /FCKeditor/.htaccess file looks like:
<pre>AddType application/x-javascript .js
AddType text/css .css
AddType text/xml .xml
<FilesMatch "\.html$">
ForceType none
</FilesMatch>
<FilesMatch "\.htm$">
ForceType none
</FilesMatch>
</pre>
The first two lines (having to do with .js and .css) I picked up from the htaccess.txt file as a troubleshooting step.

=== Security warning when using toolbar or context menu cut/copy/paste commands. How to enable them to work properly? ===

Firefox has very rigid security features that blocks script based application, like FCKeditor, to have access to the computer clipboard. So, when using this browser, it is quite common to see a warning like the following when clicking in the “Cut” button on the toolbar:

''"Your browser security settings don’t permit the editor to automatically execute cutting operations. Please use the keyboard for that (Ctrl+X)"''

There are ways to configure Firefox, granting the necessary permissions to FCKeditor to make pasting operations. Detailed info can be found here: http://kb.mozillazine.org/Granting_JavaScript_access_to_the_clipboard

To make the configurations easy and very intuitive (integrated with the FCKeditor interface), I recommend the following extension: http://allowclipboard.foxinus.cz/

=== Blank popups (e.g. from Source button) with Gecko browsers (!SeaMonkey, Firefox, ...) ===

It must have been some extension which set the preference '''capability.policy.default.Window.resizeTo''' to the value '''noAccess'''. The preference does not appear in about:config, so it's even harder to detect. I found it by going through prefs.js (located in the folder of the respective profile).

=== The toolbar doesn't load in Firefox and I get an error message in the console: this.DOMDocument has no properties ===

This problem is usually due to your server doesn't returning the proper MIME type for the .xml files (fck_styles.xml). You can verify that removing the styles combo from the toolbar and loading again the editor (after clearing the cache) fixes the problem.

The problem can be due to different reasons at the server side:

* Mime type not configured for .xml files, can be solved in Apache by putting a .htaccess file into the base directory with the following:
<pre>Addtype text/xml .xml
</pre>
* Restriction to use .xml files due to security concerns. You'll need to set up another extension as text/xml and use that or use a dinamic page with the proper content type.

'''NOTE''': It should be better if the editor was coded to handle this error and show a warning message instead of silently failing.

=== The editor's content is empty when submitting the editor's surrounding form by ajax. What is wrong? ===

This problem is caused by a missing call of the function '''FCK.UpdateLinkedField()'''. By submitting the editor's surrounding form with an ajax function the values of all form elements are collected in a javascript object (some kind of an array). At this time the value of the hidden field that usually contains the editor's html output is empty, because the editor's surrounding form wasn't submitted for real, you can call it a simulated submit. The workaround is to call the FCK.UpdateLinkedField() function before submitting the form. Either you call it directly before the ajax collect function or in the onClick attribute of the submit button. For general use, even if you have more than one FCKeditor instance, I wrote the following hack to solve the problem.
<pre>// Some Class
function MyClass()
{
this.UpdateEditorFormValue = function()
{
for ( i = 0; i < parent.frames.length; ++i )
if ( parent.frames[i].FCK )
parent.frames[i].FCK.UpdateLinkedField();
}
}
// instantiate the class
var MyObject = new MyClass();
</pre>
Now can call this method in the onSubmit attribute of the editor's surrounding form before calling the ajax collecting function:
<pre><form ... onSubmit="MyObject.UpdateEditorFormValue(); Ajax.Collect(); return false;">
</pre>
'''NOTE''': the previous syntax won't work if using VisualStudio 2005 and Atlas and IE. It will be ok to use:
<pre><form ... onSubmit="MyObject.UpdateEditorFormValue(); return true;">
</pre>
Or you'll do it in the onClick attribute of the submit button, which is also called before the onSubmit event: <input type="submit" ... onClick="MyObject.UpdateEditorFormValue();" /> ''Edited by heiligkind ( hollo@heiligkind.de ) 17 August 2006''

A german version can be found at: http://blog.heiligkind.de/category/nutzliches/

=== The editor's content is empty inside an ASP.NET AJAX UpdatePanel ===

If you have trouble getting FCKeditor's '.Value' inside an ASP.NET AJAX UpdatePanel try registering your submit button for a full postback.

Declaratively:
<pre><asp:ScriptManager ID="ScriptManager1" runat="server"/>
<asp:UpdatePanel ID="UpdatePanel1" UpdateMode="Conditional" runat="server">
<ContentTemplate>
<FCKeditorV2:FCKeditor id="Editor1" BasePath="~/Resources/FCKeditor/" runat="server" />
<asp:Button runat="server" Text="Button1" OnClick="Button1_click"></asp:Button>
</ContentTemplate>
<Triggers>
<asp:PostBackTrigger ControlID="Button1" />
</Triggers>
</asp:UpdatePanel>
</pre>
Or in CodeBehind:
<pre>protected void Page_Load(object sender, EventArgs e) {
ScriptManager1.RegisterPostBackControl(Button1);
}
</pre>
=== There is just an empty Field, when JavaScript is disabled. What is wrong? ===

This problem is caused by a missing fallback implementation in the PHP method FCKeditor::createHTML(). Even if '''JavaScript''' is disabled this function returns an output to display the FCKeditor's IFrame, which only works if JavaScript is enabled. Infact you're not able to get information in PHP if JavaScript is enabled or not, so we have to do a little workaround for a fallback by using the good old [noscript] tag. To keep the FCKeditor's files updatable, it's recommanded to extend the main class. And this is, how it works:
<pre>// include FCKeditor's main class
require_once 'fckeditor/fckeditor.php';
/**
* extended class MyFCKeditor
*/
class MyFCKeditor extends FCKeditor
{
/**
* returns the Editor's HTML output
*/
public function returnEditor()
{
// create plaintext, if JavaScript is disabled
// replace / by "\n"
$noscript_value = str_replace( ' ', "\n", $this->Value );
$noscript_value = str_replace( ' ', "\n", $this->Value );
// remove all tags (could be HTML content)
$noscript_value = strip_tags( $noscript_value );
// remove tabs (probably createt by HTML formatting)
$noscript_value = str_replace( "\t", "", $noscript_value );
// set the width of the textarea
$noscript_width = strpos( $this->Width, '%' ) ? $this->Width : $this->Width . 'px';
// create return string
$returner = '<script langauge="JavaScript1.2" type="text/javascript">';
// JavaScript is enabled
$returner .= "document.write('";
// "\n" entfernen, da sonst ein JavaScript Fehler entsteht
$returner .= str_replace( "\n", "", $this->CreateHtml() );
$returner .= "');</script>";
// JavaScript is disabled
$returner .= '<noscript>';
$returner .= '<textarea name="' . $this->InstanceName . '" ';
$returner .= 'style="width:' . $noscript_width . ';';
$returner .= 'height:' . $this->Height . 'px;">';
$returner .= $noscript_value . '</textarea>';
$returner .= '</noscript>';
// return
return $returner;
}
}
// Initialize a new editor instance
$editor = new MyFCKeditor();
$editor->Height = '100';
$editor->Width = '100%'
$editor->Value = 'Hallo, das ist ein dicker Text!';
// print the editor's code
echo $editor->returnEditor();
</pre>
Now, if JavaScript is enabled the FCKeditor is displayed as usual, otherwie ther will be a textarea.

''Edited by heiligkind ( hollo@heiligkind.de ) 17 August 2006''

A german version can be found at:http://blog.heiligkind.de/category/nutzliches/

=== With ASP.NET, I need to submit twice when using the RequiredFieldValidator in a FCKeditor instance ===

FCKeditor will not work properly with the Required Field Validator when the "EnableClientScript" property of the validator is set to "true" (default). Due to a limitation in the default validation system, you must set it to "false".

If you want to do client side validation, you must use a Custom Validator instead and provide the appropriate validation function, using the FCKeditor JavaScript API.

=== Strange attribute named "ilo-full-src" on images when working with Firefox ===

It may happen if you have the "ImgLikeOpera" extension installed. Just disable it and everything will work fine.

=== The panels containing font styles, size, color etc are incorrectly positioned when they appear in Firefox ===

Try wrapping your <textarea></textarea> tags in a div with position set to 'relative'. Like so:
<pre><div style="position: relative;"><textarea id="myTextArea"></textarea></div>
</pre>
=== The showborders option isn't working on IE so that tables with border=0 are invisible in the edit window ===

IE support for this option is provided via a .htc behavior. On my server, however, the mime-type for .htc files was not set correctly and so IE was not using them (see the Microsoft Knowledge Base article at http://support.microsoft.com/kb/306231). Adding the line:
<pre>AddType text/x-component .htc
</pre>
to my .htaccess file resolved this problem.

FCKeditor 2.x/Developers Guide/FAQ

2008-01-23T10:54:46Z

W.olchawa:

__NOTOC__
== Frequently Asked Questions ==

In this page you can find Frequently Asked Questions (and answers) about FCKeditor. '''Please do not use this page just for asking questions'''. For support and discussion questions I invite you to go to our [http://www.fckeditor.net/forums/: Forums].

* [[FCKeditor 2.x/Developers Guide/FAQ/JavaScirpt|JavaScript Related FAQ]]

* [[#commercial|Can I use FCKeditor in my commercial software? Must my software be Open Source too?]]
* [[#safari|Does FCKeditor work with Safari, over Mac?]]
* [[#fckname|What about the "FCKeditor" name?]]
* [[#aboutbox|Do I have to show the original about box in the toolbar?]]
* [[#requesterror|In the file browser, I'm having a "XML Request Error : Internal Server Error (500)" . How to find out the problem?]]

=== Can I use FCKeditor in my commercial software? Must my software be Open Source too? ===

The editor is licensed under the Open Source GPL, LGPL and MPL licenses making it possible to use it with almost all kinds of software. If these Open Source licenses terms satisfy your needs, you can freely use FCKeditor in your commercial software. You may use any GPL, LGPL or MPL compatible license you want for your software, and it is not mandatory for it to be Open Source or Free Software.

Even if it is free to use FCKeditor, consider giving something back to the project, mainly when using it on commercial software. In this way you can help us maintain the project and the high quality of the editor. It is also the only way for us to compete with commercial editors. Take a look at our [http://www.fckeditor.net/license/commercial commercial license] and the [http://www.fckeditor.net/support e-mail support] for some options.

For many companies and products, Open Source licenses or the donation mechanism is not an option. This is why the Closed Distribution License has been introduced: http://www.fckeditor.net/license/commercial

=== Does FCKeditor work with Safari, over Mac? ===

Take a look here: http://www.fckeditor.net/safari

=== What about the "FCKeditor" name? ===

The editor name starts with the initials of its author, Frederico Caldeira Knabben (see [http://www.acronymfinder.com/af-query.asp?String=exact&Acronym=FCK Acronym Finder]). It must be written with the "FCK" initials in uppercase, concatenated with the "editor" word in lowercase, with no spaces between them. It is pronounced as you "should" read it: "eff see kay editor".

=== Do I have to show the original about box in the toolbar? ===

No. There is no problem on removing the About button from the toolbar. You don't need to show the editor name to your end users at all.

In any case, the legal notices in the editor sources must remain untouched.

=== In the file browser, I'm having a "XML Request Error : Internal Server Error (500)" . How to find out the problem? ===

The editor uses a "connector" in the file browser to communicate with the server, through XML, and retrieve files and folders. The connector is available in different programming languages, as ASP and PHP for example.

By default, it is configured to use the ASP one. Be sure you have configured the editor to use the appropriate connector for your preferred language. You can do that in the fckconfig.js file or in your custom [[FCKeditor 2.x/Developers Guide/Configuration/Configuration File|Configuration File]].

If the configurations seem to be OK, you can use the test page that comes with the connector to check the XML responses that the connector sends and maybe identify errors on the server side. The test page for version before 2.5 is located at "editor/filemanager/browser/default/connectors/test.html". In 2.5 the location has been moved to "editor/filemanager/connectors/test.html"

Another thing to check is that the target folder for the files exists in your server. By default it uses the "/UserFiles/" folder, but it is configurable.

The editor uses a fixed structure in the target folder that separate files used on different dialog boxes, respectively the link, file and flash dialogs. For example, if you are using the "/UserFiles/" as your target file, it will use "/UserFiles/File/", "/UserFiles/Image/", "/UserFiles/Flash/" and "/UserFiles/Media/". The connector tries to create those directories automatically, but on some configurations they need to be created manually to make it work properly.

'''NOTE for ASP connector''' : another workaround seem to re-install VBScript runtime (from http://msdn.microsoft.com/scripting) and/or MDAC (from http://msdn.microsoft.com/data/mdac/). ''Ultimate way'' : register the scripting library with running "''regsvr32 vbscript.dll''" in the "''<windows folder>\system32\''" folder. Also, if IIS is configured to allow "Anonymous" acces, ensure that the IUSR_MACHINENAME account has write permissions to the folder(s).

'''NOTE for PHP connector''' : some others problems can generate XML HTTP request error (FCKeditor release 2.2)

FCKeditor 2.x/Developers Guide/FAQ

2008-01-23T10:54:25Z

W.olchawa:

__NOTOC__
== Frequently Asked Questions ==

In this page you can find Frequently Asked Questions (and answers) about FCKeditor. '''Please do not use this page just for asking questions'''. For support and discussion questions I invite you to go to our [http://www.fckeditor.net/forums/: Forums].

* [[FCKeditor 2.x/Developers Guide/FAQ/JavaScirpt|JavaScript Related FAQ]]

* [[#commercial|Can I use FCKeditor in my commercial software? Must my software be Open Source too?]]
* [[#safari|Does FCKeditor work with Safari, over Mac?]]
* [[#fckname|What about the "FCKeditor" name?]]
* [[#aboutbox|Do I have to show the original about box in the toolbar?]]
* [[#requesterror|In the file browser, I'm having a "XML Request Error : Internal Server Error (500)" . How to find out the problem?]]

=== Can I use FCKeditor in my commercial software? Must my software be Open Source too? ===

The editor is licensed under the Open Source GPL, LGPL and MPL licenses making it possible to use it with almost all kinds of software. If these Open Source licenses terms satisfy your needs, you can freely use FCKeditor in your commercial software. You may use any GPL, LGPL or MPL compatible license you want for your software, and it is not mandatory for it to be Open Source or Free Software.

Even if it is free to use FCKeditor, consider giving something back to the project, mainly when using it on commercial software. In this way you can help us maintain the project and the high quality of the editor. It is also the only way for us to compete with commercial editors. Take a look at our [http://www.fckeditor.net/license/commercial commercial license] and the [http://www.fckeditor.net/support e-mail support] for some options.

For many companies and products, Open Source licenses or the donation mechanism is not an option. This is why the Closed Distribution License has been introduced: http://www.fckeditor.net/license/commercial

=== Does FCKeditor work with Safari, over Mac? ===

Take a look here: http://www.fckeditor.net/safari

=== What about the "FCKeditor" name? ===

The editor name starts with the initials of its author, Frederico Caldeira Knabben (see [http://www.acronymfinder.com/af-query.asp?String=exact&Acronym=FCK: Acronym Finder]). It must be written with the "FCK" initials in uppercase, concatenated with the "editor" word in lowercase, with no spaces between them. It is pronounced as you "should" read it: "eff see kay editor".

=== Do I have to show the original about box in the toolbar? ===

No. There is no problem on removing the About button from the toolbar. You don't need to show the editor name to your end users at all.

In any case, the legal notices in the editor sources must remain untouched.

=== In the file browser, I'm having a "XML Request Error : Internal Server Error (500)" . How to find out the problem? ===

The editor uses a "connector" in the file browser to communicate with the server, through XML, and retrieve files and folders. The connector is available in different programming languages, as ASP and PHP for example.

By default, it is configured to use the ASP one. Be sure you have configured the editor to use the appropriate connector for your preferred language. You can do that in the fckconfig.js file or in your custom [[FCKeditor 2.x/Developers Guide/Configuration/Configuration File|Configuration File]].

If the configurations seem to be OK, you can use the test page that comes with the connector to check the XML responses that the connector sends and maybe identify errors on the server side. The test page for version before 2.5 is located at "editor/filemanager/browser/default/connectors/test.html". In 2.5 the location has been moved to "editor/filemanager/connectors/test.html"

Another thing to check is that the target folder for the files exists in your server. By default it uses the "/UserFiles/" folder, but it is configurable.

The editor uses a fixed structure in the target folder that separate files used on different dialog boxes, respectively the link, file and flash dialogs. For example, if you are using the "/UserFiles/" as your target file, it will use "/UserFiles/File/", "/UserFiles/Image/", "/UserFiles/Flash/" and "/UserFiles/Media/". The connector tries to create those directories automatically, but on some configurations they need to be created manually to make it work properly.

'''NOTE for ASP connector''' : another workaround seem to re-install VBScript runtime (from http://msdn.microsoft.com/scripting) and/or MDAC (from http://msdn.microsoft.com/data/mdac/). ''Ultimate way'' : register the scripting library with running "''regsvr32 vbscript.dll''" in the "''<windows folder>\system32\''" folder. Also, if IIS is configured to allow "Anonymous" acces, ensure that the IUSR_MACHINENAME account has write permissions to the folder(s).

'''NOTE for PHP connector''' : some others problems can generate XML HTTP request error (FCKeditor release 2.2)

FCKeditor 2.x/Developers Guide/Developer's Web Site

2008-01-23T10:53:56Z

W.olchawa:

== Developer's Web Site ==

Please view the [http://dev.fckeditor.net/ FCKeditor Project developer's web site]. There you will find several information regarding to coding routine, registering bugs,sub-projects and much more information which will help you to find your FCKeditor development much more easier.

FCKeditor 2.x/Developers Guide/Localization

2008-01-23T10:53:15Z

W.olchawa:

== Interface Localization ==

The languages files must be placed inside the "editor/lang" directory of the project. You can use the file "'''en.js'''" as the base file for your translations. The file names are based on the [http://www.faqs.org/rfcs/rfc3066.html RFC 3066] standards (but in lowercase) and the [http://www.loc.gov/standards/iso639-2/php/English_list.php ISO 639-1]. So, for example, a file for the '''Portuguese language''' should be called "'''pt.js'''".

Translation could also be localized for a specific country. In this case, for example, a Brazilian Portuguese translation file must be called "'''pt-br.js.'''"

The browser’s language auto detection system uses the first available language that best fits the client settings.

For example, if a client computer is set to Brazilian Portuguese and there is no pt-br.js file available, the pt.js is used if available. If still not available, the default language is used (from the configuration file, by default English).

When creating new language files, you need to add an entry for it in the "editor/_source/internals/fcklanguagemanager.js" file. Something like this:
<pre>AvailableLanguages =
{
en : 'English',
pt : 'Portuguese'
}
</pre>
To test your language file, you could run the editor using the [[FCKeditor 2.x/Developers Guide/Customization/Scripts Compression#Using the|source scripts]]. Just open the "_samples/html/sample03.html" files.

When you feel the translation is completed and the tests are done, you will need to "re-generate" the compressed JavaScript files of FCKeditor using the [[FCKeditor 2.x/Developers Guide/Customization/Scripts Compression#Using the FCKpackager|FCKpackager]]

== File Encoding ==

'''NOTE''': An important thing is to save the files in the UTF-8 encoded text format. Otherwise, some strange characters could appear instead of any special characters used by different languages, like accented letters, symbols, etc.

== Publishing ==

A ticket must be opened at our [http://dev.fckeditor.net/ development web site] for each new or updated language file contribution.

Before starting a new translation, please take a look at [http://www.fckeditor.net/developers/ our web site] and check if there is no translator assigned to your language. Of course you can also [http://dev.fckeditor.net/search check] if there are no translations made already.

FCKeditor 2.x/Developers Guide/Localization

2008-01-23T10:52:18Z

W.olchawa:

== Interface Localization ==

The languages files must be placed inside the "editor/lang" directory of the project. You can use the file "'''en.js'''" as the base file for your translations. The file names are based on the [http://www.faqs.org/rfcs/rfc3066.html RFC 3066] standards (but in lowercase) and the [http://www.loc.gov/standards/iso639-2/php/English_list.php ISO 639-1]. So, for example, a file for the '''Portuguese language''' should be called "'''pt.js'''".

Translation could also be localized for a specific country. In this case, for example, a Brazilian Portuguese translation file must be called "'''pt-br.js.'''"

The browser’s language auto detection system uses the first available language that best fits the client settings.

For example, if a client computer is set to Brazilian Portuguese and there is no pt-br.js file available, the pt.js is used if available. If still not available, the default language is used (from the configuration file, by default English).

When creating new language files, you need to add an entry for it in the "editor/_source/internals/fcklanguagemanager.js" file. Something like this:
<pre>AvailableLanguages =
{
en : 'English',
pt : 'Portuguese'
}
</pre>
To test your language file, you could run the editor using the [[FCKeditor 2.x/Developers Guide/Customization/Scripts Compression#Using the|source scripts]]. Just open the "_samples/html/sample03.html" files.

When you feel the translation is completed and the tests are done, you will need to "re-generate" the compressed JavaScript files of FCKeditor using the [[FCKeditor 2.x/Developers Guide/Customization/Scripts Compression#Using the FCKpackager|FCKpackager]]

== File Encoding ==

'''NOTE''': An important thing is to save the files in the UTF-8 encoded text format. Otherwise, some strange characters could appear instead of any special characters used by different languages, like accented letters, symbols, etc.

== Publishing ==

A ticket must be opened at our [http://dev.fckeditor.net/:development web site] for each new or updated language file contribution.

Before starting a new translation, please take a look at [http://www.fckeditor.net/developers/:our web site] and check if there is no translator assigned to your language. Of course you can also [http://dev.fckeditor.net/search:check] if there are no translations made already.

FCKeditor 2.x/Developers Guide/JavaScript API

2008-01-23T10:51:03Z

W.olchawa:

== FCKeditor JavaScript API ==

FCKeditor offers a complete JavaScript API so you can interact with it once the editor is loaded and running.

Once loaded, the editor registers a global object called '''FCKeditorAPI'''. This object offers the entry point to interact with any editor instance placed in a page (you can have more than one).

'''NOTE''': The '''FCKeditorAPI''' object will not be available during the page load. You need to wait for the editor to be loaded to use it. If you need to interact with the editor right after is has been loaded, use the "FCKeditor_OnComplete" function (see [[FCKeditor 2.x/Developers Guide/JavaScript API#Events|Events]]).

== Retrieving an Editor Instance ==

* '''From out of an external script''' When placing the editor in the page, you give it an "instance name". To retrieve it, you must simply call the '''FCKeditorAPI.GetInstance''' method. Example:<pre>var oEditor = FCKeditorAPI.GetInstance('InstanceName') ;
</pre>

* '''From out of a dialog of the editor''' Call the InnerDialogLoaded to get the FCKObject. Example:<pre>var oEditor = window.parent.InnerDialogLoaded().FCK ;
</pre>

Both methods return the main FCKeditor object that gives the necessary bridge to interact with it. These are the most useful properties and methods of this object:

Properties:

* '''Name = ( string )''' - the instance name.
* '''Status = ( integer )''' - the editor status (loading status).
* '''EditorDocument = ( object )''' - the DOM Document object for the editing area.
* '''EditorWindow = ( object )''' - the DOM Window object for the editing area.

Methods:

* '''AttachToOnSelectionChange( functionPointer )'''
* '''Focus()'''
* '''GetXHTML( formatted )'''
* '''InsertElement( element )'''
* '''InsertElementAndGetIt( e )'''
* '''InsertHtml( html )''' - inserts HTML in the current cursor position
* '''IsDirty()''' - checks if the content in the editor has been changed
* '''MakeEditable()'''
* '''ResetIsDirty()''' - resets the dirty state
* '''SetHTML( html )''' - sets the contents of the editor. Note that when using this method, you will loose any listener that you may have previously registered on the editor.EditorDocument.
* '''GetHTML()''' - retrieves the edited html from the editor.
* '''SwitchEditMode()'''
* '''UpdateLinkedField()'''

== Events ==

Once the editor loading phase is complete and it is ready to use (and interact with JavaScript), a standard function is called in the page that contains the editor, if the function is defined. This function must be named '''"FCKeditor_OnComplete"''' and receives the related editor instance as the parameter. Using it, you can execute any initial code that may interact with the editor. This is a declaration example:
<pre>function FCKeditor_OnComplete( editorInstance )
{
alert( editorInstance.Name ) ;
}
</pre>
Other than the above standard function, every FCKeditor instance has an "Event" object that can be used to listen for events to be fired.

Example: the following code listens for the "OnSelectionChange" to execute custom code:
<pre>function FCKeditor_OnComplete( editorInstance )
{
editorInstance.Events.AttachEvent( 'OnSelectionChange', DoSomething ) ;
}
var counter = 0 ;
function DoSomething( editorInstance )
{
// This is a sample function that shows in the title bar the number of times
// the "OnSelectionChange" event is called.
window.document.title = editorInstance.Name + ' : ' + ( ++counter ) ;
}
</pre>
Note that every event callback function receives the editor instance as a parameter.

The following is the list of events available:

* '''OnAfterLinkedFieldUpdate''' - fired right after the hidden linked field attached to the editor has its contents updated. It happens usually when the form is being posted.
* '''OnAfterSetHTML''' - fired once the HTML is loaded in the editor (including when changing views).
* '''OnFocus''' - fired when the editor acquires the focus.
* '''OnPaste''' - fired when something is pasted in the editor. The function you specify must return true for the paste to proceed.
* '''OnStatusChange''' - fired when the editor status changes. The following constants are also available globally in the page: FCK_STATUS_NOTLOADED, FCK_STATUS_ACTIVE and FCK_STATUS_COMPLETE.
* '''OnSelectionChange''' - fired when the actual selection in the editor area changes (including cursor position and keystrokes). Note: In IE, this event does not fire on every keystroke, but only on some random keystrokes.

== Usage Samples ==

The following are a few samples of things that can be done with the JavaScript API. (In these samples, oEditor = FCKeditorAPI.GetInstance('InstanceName').)

* '''Insert HTML at cursor position''':<pre>oEditor.InsertHtml(HTML);</pre>
* '''Triggering a toolbar button / command''':<pre>oEditor.Commands.GetCommand(commandName).Execute();</pre>
* '''Disabling toolbar buttons''':<pre>oEditor.EditorWindow.parent.FCKToolbarItems.LoadedItems[commandName].Disable();</pre>
* '''Setting a config value''':<pre>oEditor.Config['<configVariableName>'] = 'newValue';</pre>
* '''Change editor document style at runtime''':<pre>oEditor.EditorDocument.body.style.cssText += 'color: #322805; background-color: #F7C928;' ;</pre>
* '''Set or get anything of the editor''':<pre>FCKeditorAPI.GetInstance('InstanceName').EditorWindow.parent...</pre>
* '''Add a dynamic Save function''':
<pre>
// called on save
function doSave(){
alert('Saved.');
document.getElementById('someElement').innerHTML = 'Saved!';
return false; //this disables default action (submitting the form)
}
// called when FCKeditor is done starting..
function FCKeditor_OnComplete( editorInstance ){
editorInstance.LinkedField.form.onsubmit = doSave;
}
</pre>

* '''Working with the selection in the editor''': Use the Selection Object

FCKeditor 2.x/Developers Guide/JavaScript API

2008-01-23T10:50:12Z

W.olchawa:

== FCKeditor JavaScript API ==

FCKeditor offers a complete JavaScript API so you can interact with it once the editor is loaded and running.

Once loaded, the editor registers a global object called '''FCKeditorAPI'''. This object offers the entry point to interact with any editor instance placed in a page (you can have more than one).

'''NOTE''': The '''FCKeditorAPI''' object will not be available during the page load. You need to wait for the editor to be loaded to use it. If you need to interact with the editor right after is has been loaded, use the "FCKeditor_OnComplete" function (see [[FCKeditor 2.x/Developers Guide/JavaScript API#Events|Events]]).

== Retrieving an Editor Instance ==

* '''From out of an external script''' When placing the editor in the page, you give it an "instance name". To retrieve it, you must simply call the '''FCKeditorAPI.GetInstance''' method. Example:<pre>var oEditor = FCKeditorAPI.GetInstance('InstanceName') ;
</pre>

* '''From out of a dialog of the editor''' Call the InnerDialogLoaded to get the FCKObject. Example:<pre>var oEditor = window.parent.InnerDialogLoaded().FCK ;
</pre>

Both methods return the main FCKeditor object that gives the necessary bridge to interact with it. These are the most useful properties and methods of this object:

Properties:

* '''Name = ( string )''' - the instance name.
* '''Status = ( integer )''' - the editor status (loading status).
* '''EditorDocument = ( object )''' - the DOM Document object for the editing area.
* '''EditorWindow = ( object )''' - the DOM Window object for the editing area.

Methods:

* '''AttachToOnSelectionChange( functionPointer )'''
* '''Focus()'''
* '''GetXHTML( formatted )'''
* '''InsertElement( element )'''
* '''InsertElementAndGetIt( e )'''
* '''InsertHtml( html )''' - inserts HTML in the current cursor position
* '''IsDirty()''' - checks if the content in the editor has been changed
* '''MakeEditable()'''
* '''ResetIsDirty()''' - resets the dirty state
* '''SetHTML( html )''' - sets the contents of the editor. Note that when using this method, you will loose any listener that you may have previously registered on the editor.EditorDocument.
* '''GetHTML()''' - retrieves the edited html from the editor.
* '''SwitchEditMode()'''
* '''UpdateLinkedField()'''

== Events ==

Once the editor loading phase is complete and it is ready to use (and interact with JavaScript), a standard function is called in the page that contains the editor, if the function is defined. This function must be named '''"FCKeditor_OnComplete"''' and receives the related editor instance as the parameter. Using it, you can execute any initial code that may interact with the editor. This is a declaration example:
<pre>function FCKeditor_OnComplete( editorInstance )
{
alert( editorInstance.Name ) ;
}
</pre>
Other than the above standard function, every FCKeditor instance has an "Event" object that can be used to listen for events to be fired.

Example: the following code listens for the "OnSelectionChange" to execute custom code:
<pre>function FCKeditor_OnComplete( editorInstance )
{
editorInstance.Events.AttachEvent( 'OnSelectionChange', DoSomething ) ;
}
var counter = 0 ;
function DoSomething( editorInstance )
{
// This is a sample function that shows in the title bar the number of times
// the "OnSelectionChange" event is called.
window.document.title = editorInstance.Name + ' : ' + ( ++counter ) ;
}
</pre>
Note that every event callback function receives the editor instance as a parameter.

The following is the list of events available:

* '''OnAfterLinkedFieldUpdate''' - fired right after the hidden linked field attached to the editor has its contents updated. It happens usually when the form is being posted.
* '''OnAfterSetHTML''' - fired once the HTML is loaded in the editor (including when changing views).
* '''OnFocus''' - fired when the editor acquires the focus.
* '''OnPaste''' - fired when something is pasted in the editor. The function you specify must return true for the paste to proceed.
* '''OnStatusChange''' - fired when the editor status changes. The following constants are also available globally in the page: FCK_STATUS_NOTLOADED, FCK_STATUS_ACTIVE and FCK_STATUS_COMPLETE.
* '''OnSelectionChange''' - fired when the actual selection in the editor area changes (including cursor position and keystrokes). Note: In IE, this event does not fire on every keystroke, but only on some random keystrokes.

== Usage Samples ==

The following are a few samples of things that can be done with the JavaScript API. (In these samples, oEditor = FCKeditorAPI.GetInstance('InstanceName').)

* '''Insert HTML at cursor position''':<pre>oEditor.InsertHtml(HTML);</pre>
* '''Triggering a toolbar button / command''':<pre>oEditor.Commands.GetCommand(commandName).Execute();</pre>
* '''Disabling toolbar buttons''':<pre>oEditor.EditorWindow.parent.FCKToolbarItems.LoadedItems[commandName].Disable();</pre>
* '''Setting a config value''':<pre>oEditor.Config['<configVariableName>'] = 'newValue';</pre>
* '''Change editor document style at runtime''':<pre>oEditor.EditorDocument.body.style.cssText += 'color: #322805; background-color: #F7C928;' ;</pre>
* '''Set or get anything of the editor''':<pre>FCKeditorAPI.GetInstance('InstanceName').EditorWindow.parent...</pre>
* '''Add a dynamic Save function''':<pre>// called on save
function doSave(){
alert('Saved.');
document.getElementById('someElement').innerHTML = 'Saved!';
return false; //this disables default action (submitting the form)
}
// called when FCKeditor is done starting..
function FCKeditor_OnComplete( editorInstance ){
editorInstance.LinkedField.form.onsubmit = doSave;
}

</pre>

* '''Working with the selection in the editor''': Use the Selection Object

FCKeditor 2.x/Developers Guide/JavaScript API

2008-01-23T10:49:30Z

W.olchawa:

== FCKeditor JavaScript API ==

FCKeditor offers a complete JavaScript API so you can interact with it once the editor is loaded and running.

Once loaded, the editor registers a global object called '''FCKeditorAPI'''. This object offers the entry point to interact with any editor instance placed in a page (you can have more than one).

'''NOTE''': The '''FCKeditorAPI''' object will not be available during the page load. You need to wait for the editor to be loaded to use it. If you need to interact with the editor right after is has been loaded, use the "FCKeditor_OnComplete" function (see [[FCKeditor 2.x/Developers Guide/JavaScript API#Events|Events]]).

== Retrieving an Editor Instance ==

* '''From out of an external script''' When placing the editor in the page, you give it an "instance name". To retrieve it, you must simply call the '''FCKeditorAPI.GetInstance''' method. Example:<pre>var oEditor = FCKeditorAPI.GetInstance('InstanceName') ;
</pre>

* '''From out of a dialog of the editor''' Call the InnerDialogLoaded to get the FCKObject. Example:<pre>var oEditor = window.parent.InnerDialogLoaded().FCK ;
</pre>

Both methods return the main FCKeditor object that gives the necessary bridge to interact with it. These are the most useful properties and methods of this object:

Properties:

* '''Name = ( string )''' - the instance name.
* '''Status = ( integer )''' - the editor status (loading status).
* '''EditorDocument = ( object )''' - the DOM Document object for the editing area.
* '''EditorWindow = ( object )''' - the DOM Window object for the editing area.

Methods:

* '''AttachToOnSelectionChange( functionPointer )'''
* '''Focus()'''
* '''GetXHTML( formatted )'''
* '''InsertElement( element )'''
* '''InsertElementAndGetIt( e )'''
* '''InsertHtml( html )''' - inserts HTML in the current cursor position
* '''IsDirty()''' - checks if the content in the editor has been changed
* '''MakeEditable()'''
* '''ResetIsDirty()''' - resets the dirty state
* '''SetHTML( html )''' - sets the contents of the editor. Note that when using this method, you will loose any listener that you may have previously registered on the editor.EditorDocument.
* '''GetHTML()''' - retrieves the edited html from the editor.
* '''SwitchEditMode()'''
* '''UpdateLinkedField()'''

== Events ==

Once the editor loading phase is complete and it is ready to use (and interact with JavaScript), a standard function is called in the page that contains the editor, if the function is defined. This function must be named '''"FCKeditor_OnComplete"''' and receives the related editor instance as the parameter. Using it, you can execute any initial code that may interact with the editor. This is a declaration example:
<pre>function FCKeditor_OnComplete( editorInstance )
{
alert( editorInstance.Name ) ;
}
</pre>
Other than the above standard function, every FCKeditor instance has an "Event" object that can be used to listen for events to be fired.

Example: the following code listens for the "OnSelectionChange" to execute custom code:
<pre>function FCKeditor_OnComplete( editorInstance )
{
editorInstance.Events.AttachEvent( 'OnSelectionChange', DoSomething ) ;
}
var counter = 0 ;
function DoSomething( editorInstance )
{
// This is a sample function that shows in the title bar the number of times
// the "OnSelectionChange" event is called.
window.document.title = editorInstance.Name + ' : ' + ( ++counter ) ;
}
</pre>
Note that every event callback function receives the editor instance as a parameter.

The following is the list of events available:

* '''OnAfterLinkedFieldUpdate''' - fired right after the hidden linked field attached to the editor has its contents updated. It happens usually when the form is being posted.
* '''OnAfterSetHTML''' - fired once the HTML is loaded in the editor (including when changing views).
* '''OnFocus''' - fired when the editor acquires the focus.
* '''OnPaste''' - fired when something is pasted in the editor. The function you specify must return true for the paste to proceed.
* '''OnStatusChange''' - fired when the editor status changes. The following constants are also available globally in the page: FCK_STATUS_NOTLOADED, FCK_STATUS_ACTIVE and FCK_STATUS_COMPLETE.
* '''OnSelectionChange''' - fired when the actual selection in the editor area changes (including cursor position and keystrokes). Note: In IE, this event does not fire on every keystroke, but only on some random keystrokes.

== Usage Samples ==

The following are a few samples of things that can be done with the JavaScript API. (In these samples, oEditor = FCKeditorAPI.GetInstance('InstanceName').)

* '''Insert HTML at cursor position''':<pre>oEditor.InsertHtml(HTML);</pre>
* '''Triggering a toolbar button / command''':<pre>oEditor.Commands.GetCommand(commandName).Execute();</pre>
* '''Disabling toolbar buttons''':<pre>oEditor.EditorWindow.parent.FCKToolbarItems.LoadedItems[commandName].Disable();</pre>
* '''Setting a config value''':<pre>oEditor.Config['<configVariableName>'] = 'newValue';</pre>
* '''Change editor document style at runtime''':<pre>oEditor.EditorDocument.body.style.cssText += 'color: #322805; background-color: #F7C928;' ;</pre>
* '''Set or get anything of the editor''':<pre>FCKeditorAPI.GetInstance('InstanceName').EditorWindow.parent...</pre>
* '''Add a dynamic Save function''':<pre>// called on save
function doSave(){
alert('Saved.');
document.getElementById('someElement').innerHTML = 'Saved!';
return false; //this disables default action (submitting the form)
}
// called when FCKeditor is done starting..
function FCKeditor_OnComplete( editorInstance ){
editorInstance.LinkedField.form.onsubmit = doSave;
}

</pre>

* '''Working with the selection in the editor''': Use the Selection Object

FCKeditor 2.x/Developers Guide/Configuration/Spell Checker

2008-01-23T10:44:41Z

W.olchawa:

== Spell Checker Configuration ==

FCKeditor comes with built-in integration with two spell checkers: '''ieSpell''' and '''Speller Pages'''. Here you will find information about these spell checkers and how to configure them.

=== ieSpell ===

As the name says, ieSpell is an extension for Internet Explorer that does spell checking at the client side. It is quite simple and efficient, but it runs on IE/Windows only.

To use ieSpell just set the following configuration in fckconfig.js or in your own [[FCKeditor 2.x/Developers Guide/Configuration/Configuration File|Configuration File]]:
<pre>FCKConfig.SpellChecker = 'ieSpell' ;
</pre>
The first time a user runs the Spell Checker, he/she will be automatically informed that ieSpell is not installed and will be redirected to the download URL (the URL can also be configured using [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/IeSpellDownloadUrl|IeSpellDownloadUrl]] option).

When running FCKeditor with ieSpell with non-IE browsers, the "Check Spell" button will be automatically disabled.

'''NOTE''': ieSpell is free for personal use. Commercial licenses are available for very low prices. For more info about ieSpell, its licensing, configurations and more, go to http://www.iespell.com/.

=== Speller Pages ===

Speller Pages is a free, Open Source, server side spell checker that uses the powerful [http://aspell.net/ GNU Aspell] engine for the hard work. This should be the preferred spell checker, but it requires some server side configuration (this is why it is not set as the default one).

To use Speller Pages just set the following configuration in fckconfig.js or in your own [[FCKeditor 2.x/Developers Guide/Configuration/Configuration File|Configuration File]]:
<pre>FCKConfig.SpellChecker = 'SpellerPages' ;
</pre>
FCKeditor uses a customized version of Speller Pages, so any specific configuration must be done in the files found at: '''editor/dialog/fck_spellerpages/spellerpages'''. All changed lines have been marked with a "by FredCK" comment.

The files included in the package are set to run over Windows with PHP. Useful information about Windows configuration can be found here: [http://sourceforge.net/docman/display_doc.php?docid=19473&group_id=86602|Windows/PHP Installation Instructions].

If the server is not Windows just go to to the '''spellerpages/server-scripts''' directory, locate the appropriate file and adjust the var that holds the path to the aspell binary.

For more info about Speller Pages, its licensing, installation, configuration and more, go to http://spellerpages.sourceforge.net/.

==== Configuration options ====

* [[FCKeditor 2.x/Developers Guide/Configuration/Spell Checker/Aspell and Windows 2003 Server|Aspell and Windows 2003 Server Configuration]]
* [[FCKeditor 2.x/Developers Guide/Configuration/Spell Checker/Updating Aspell on Unix|Updating Aspell on Unix]]

FCKeditor 2.x/Developers Guide/Integration/Other

2008-01-23T10:42:57Z

W.olchawa:

In this page you will find links to third party documentation regarding FCKeditor integration.

=== Blackboard ===

http://webmedia.unmc.edu/leis/mmckenzie/fck_desc.html

=== CakePHP ===

http://bakery.cakephp.org/articles/view/143

=== CodeIgniter ===

http://codeigniter.com/wiki/FCKeditor/

=== Dada Mail ===

http://mojo.skazat.com/support/documentation/Config.pm.html#fckeditor_integration___fckeditor_url

=== Drupal ===

http://drupal.org/project/fckeditor

=== Joomla ===

[http://forge.joomla.org/sf/sfmain/do/viewProject/projects.joomlafck JoomlaFCK]

=== JSF - MyFaces ===

[http://sourceforge.net/projects/fck-faces fck-faces]

=== Lasso ===

[http://www.nabble.com/-FCKeditor--Setup-Instructions-p8874795.html FCKEditor Setup instructions]

[http://stevepiercy.com/lasso_stuff/file_perms.lasso Permissions setup tutorial (useful for making upload work)]

=== Lotus Domino ===

https://www-10.lotus.com/ldd/nd6forum.nsf/DateAllThreadedweb/09467d31ceb6c94885257084006b57db?OpenDocument

=== Mambo ===

[http://mamboxchange.com/projects/fck/ MamboFCK]

=== Movable Type ===

http://weblog.leidenuniv.nl/users/klaassenplf/archives/2005/06/10/tutorial_wysiwyg_under_movable_type_3x.html

=== Plone ===

http://plone.org/products/fckeditor

=== Ruby on Rails ===

http://trac.underpantsgnome.com/fckeditor_on_rails - with file upload support (updated [2007-01-09] - plugin ready for Rails 1.2)

http://www.joshuamcharles.com/xhtml/fckrails.php

http://www.darknexus.org.uk/page/show/FCK_Engine

=== Smarty ===

http://www.phpinsider.com/smarty-forum/viewtopic.php?t=7861

=== SPIP ===

http://www.thierryb.net/site/-FCKeditor-pour-SPIP-.html

=== Virtual (Proxy) Filesystem in .NET ===

http://blog.pixolut.com/?s=fck+editor

=== WordPress ===

http://www.deanlee.cn/wordpress/fckeditor-for-wordpress-plugin/

FCKeditor 2.x/Developers Guide/Integration/Other

2008-01-23T10:41:55Z

W.olchawa:

In this page you will find links to third party documentation regarding FCKeditor integration.

=== Blackboard ===

http://webmedia.unmc.edu/leis/mmckenzie/fck_desc.html

=== CakePHP ===

http://bakery.cakephp.org/articles/view/143

=== CodeIgniter ===

http://codeigniter.com/wiki/FCKeditor/

=== Dada Mail ===

http://mojo.skazat.com/support/documentation/Config.pm.html#fckeditor_integration___fckeditor_url

=== Drupal ===

http://drupal.org/project/fckeditor

=== Joomla ===

[http://forge.joomla.org/sf/sfmain/do/viewProject/projects.joomlafck JoomlaFCK]

=== JSF - MyFaces ===

[http://sourceforge.net/projects/fck-faces fck-faces]

=== Lasso ===

[http://www.nabble.com/-FCKeditor--Setup-Instructions-p8874795.html: FCKEditor Setup instructions]

[http://stevepiercy.com/lasso_stuff/file_perms.lasso: Permissions setup tutorial (useful for making upload work)]

=== Lotus Domino ===

https://www-10.lotus.com/ldd/nd6forum.nsf/DateAllThreadedweb/09467d31ceb6c94885257084006b57db?OpenDocument

=== Mambo ===

[http://mamboxchange.com/projects/fck/: MamboFCK]

=== Movable Type ===

http://weblog.leidenuniv.nl/users/klaassenplf/archives/2005/06/10/tutorial_wysiwyg_under_movable_type_3x.html

=== Plone ===

http://plone.org/products/fckeditor

=== Ruby on Rails ===

http://trac.underpantsgnome.com/fckeditor_on_rails - with file upload support (updated [2007-01-09] - plugin ready for Rails 1.2)

http://www.joshuamcharles.com/xhtml/fckrails.php

http://www.darknexus.org.uk/page/show/FCK_Engine

=== Smarty ===

http://www.phpinsider.com/smarty-forum/viewtopic.php?t=7861

=== SPIP ===

http://www.thierryb.net/site/-FCKeditor-pour-SPIP-.html

=== Virtual (Proxy) Filesystem in .NET ===

http://blog.pixolut.com/?s=fck+editor

=== WordPress ===

http://www.deanlee.cn/wordpress/fckeditor-for-wordpress-plugin/

FCKeditor 2.x/Developers Guide/Integration/Other

2008-01-23T10:37:52Z

W.olchawa:

In this page you will find links to third party documentation regarding FCKeditor integration.

=== Blackboard ===

http://webmedia.unmc.edu/leis/mmckenzie/fck_desc.html

=== CakePHP ===

http://bakery.cakephp.org/articles/view/143

=== CodeIgniter ===

http://codeigniter.com/wiki/FCKeditor/

=== Dada Mail ===

http://mojo.skazat.com/support/documentation/Config.pm.html#fckeditor_integration___fckeditor_url

=== Drupal ===

http://drupal.org/project/fckeditor

=== Joomla ===

[http://forge.joomla.org/sf/sfmain/do/viewProject/projects.joomlafck JoomlaFCK]

=== JSF - MyFaces ===

[http://sourceforge.net/projects/fck-faces:fck-faces]

=== Lasso ===

[http://www.nabble.com/-FCKeditor--Setup-Instructions-p8874795.html: FCKEditor Setup instructions]

[http://stevepiercy.com/lasso_stuff/file_perms.lasso: Permissions setup tutorial (useful for making upload work)]

=== Lotus Domino ===

https://www-10.lotus.com/ldd/nd6forum.nsf/DateAllThreadedweb/09467d31ceb6c94885257084006b57db?OpenDocument

=== Mambo ===

[http://mamboxchange.com/projects/fck/: MamboFCK]

=== Movable Type ===

http://weblog.leidenuniv.nl/users/klaassenplf/archives/2005/06/10/tutorial_wysiwyg_under_movable_type_3x.html

=== Plone ===

http://plone.org/products/fckeditor

=== Ruby on Rails ===

http://trac.underpantsgnome.com/fckeditor_on_rails - with file upload support (updated [2007-01-09] - plugin ready for Rails 1.2)

http://www.joshuamcharles.com/xhtml/fckrails.php

http://www.darknexus.org.uk/page/show/FCK_Engine

=== Smarty ===

http://www.phpinsider.com/smarty-forum/viewtopic.php?t=7861

=== SPIP ===

http://www.thierryb.net/site/-FCKeditor-pour-SPIP-.html

=== Virtual (Proxy) Filesystem in .NET ===

http://blog.pixolut.com/?s=fck+editor

=== WordPress ===

http://www.deanlee.cn/wordpress/fckeditor-for-wordpress-plugin/

FCKeditor 2.x/Developers Guide/SVN/SVN Basics

2008-01-23T10:34:16Z

W.olchawa:

== SVN Basics ==

[http://subversion.tigris.org/ Subversion] (SVN) is a version control system. It is designed to be distributed, concurrent and expandable.

[http://svnbook.red-bean.com/ Version Control with Subversion] is a wonderful book to help on making the first steps inside Subversion. You may also ready it online.

=== SVN Client ===

To work on the FCKeditor SVN, you need a '''SVN client''' software. There are two options that we recommend:

* [http://tortoisesvn.sourceforge.net/ TortoiseSVN] (strongly recommended), for Microsoft Windows.
* [http://subversion.tigris.org/ The official SVN client], included in most Linux and BSD distributions; available for Linux, BSD, Mac OS X, and Windows.

=== Checkout the FCKeditor trunk ===

Checkout is the act of downloading the FCKeditor code from our SVN server inside a local folder in your computer. This folder is called "local copy".

==== With TortoiseSVN ====

# Create an empty folder, which will be your local copy root. You may give any name for it, like "fckeditor".
# Right-click on the new folder and select '''SVN Checkout....'''
# In the URL of repository, paste the following URL: <pre>http://svn.fckeditor.net/FCKeditor/trunk/</pre>

==== With SVN ====

# In the command line, go to the folder where you want your local copy folder reside in.
# Type the following to checkout the trunk: <pre>svn checkout http://svn.fckeditor.net/FCKeditor/trunk/ fckeditor</pre>
Your local copy will be found in the "fckeditor" folder.

=== Updating your Local Copy ===

At any moment, you may '''update''' your local copy to grab the code changes introduced in the repository since the checkout or the last update call.

==== With TortoiseSVN ====

# Right-click on your local copy folder.
# Select '''SVN Update'''.

==== With SVN ====

# In the command line, move to your local copy folder.
# Type: <pre>svn update</pre>

=== Creating Patches ===

Suppose you are working to provide a fix for a ticket, for example ticket number 240. The first thing to be sure is that your local copy is fresh, so update it (see above).

Then, start coding inside your local copy. You can do any kind of change. Everything will be done in your computer locally. Nothing will automatically end up in the SNV server. So, you can safely play with the code.

Once you have completed coding and well tested it, you may return your changes back to the SVN, so it will be available to everybody (other than being a license requirement :). At that point, you create a '''patch file''' to attach to the ticket.

==== With TortoiseSVN ====

# Right-click on your local copy folder.
# Select '''Create patch...'''.
# TortoiseSVN will list all files that have been changed. You may select the files that are relevant to the patch. Remember that each patch must be relative to a single ticket or feature. Do not mix ticket fixes or several different features.
# Clicking "Ok", save the patch file with the appropriate name. If the patch is supposed to fix a ticket, just use the ticket number for it, like "240.patch".

The patch file is ready to be attached to the ticket.

==== With SVN ====

# In the command line, move to your local copy folder.
# Type the following, supposing you are creating a patch file for ticket 240: <pre>svn diff > 240.patch</pre>
The patch file is ready to be attached to the ticket.

=== Applying Patches ===

Suppose you have a fresh local copy of the FCKeditor trunk repository and you want to apply a patch found in one of our tickets.

==== With TortoiseSVN ====

# Right-click on your local copy folder.
# Select '''Apply patch...'''.
# Select the patch file. You will be presented with the "Diff" tool, so you can review all changes.
# In the "File patches" window list, right-click and select "Patch all".

==== With SVN ====

The official SVN program doesn't include a built in command to apply patches. To do that, you can use the regular "patch" Unix utility:<pre>patch -p0 < patch_file</pre>
You may also find a [http://gnuwin32.sourceforge.net/ Windows port for the patch program].

FCKeditor 2.x/Developers Guide/SVN/SVN Basics

2008-01-23T10:26:03Z

W.olchawa:

FCKeditor 2.x/Developers Guide/SVN/SVN Basics

2008-01-23T10:23:53Z

W.olchawa:

FCKeditor 2.x/Developers Guide/SVN

2008-01-23T10:23:19Z

W.olchawa:

== Development SVN ==

The SVN repository used for the development can be found at ([http://dev.fckeditor.net/browser browsable]):

http://svn.fckeditor.net

The SVN contains the "development version" of FCKeditor. It doesn't reflect the contents of public distributions. Actually, some files are not present in the public downloads (like the "_dev" folder or the compressed "js" files, for example).

'''We don't recommend using this version on production.''' There are also security implications on doing so. To make the SVN version "production safe", it must be processed with FCKreleaser (available inside _dev). A safer and easier option is to simply use the Nightly Build, which is already processed.

== Nightly Build ==

Every night, at 0:30 PST, a "'''Nightly Build'''" is generated, from the SVN version. You may download it from one of the following links:

* http://www.fckeditor.net/nightly/FCKeditor_N.zip
* http://www.fckeditor.net/nightly/FCKeditor_N.tar.gz

You may also test it online [http://www.fckeditor.net/nightly/fckeditor/_samples/default.html here].

The nightly is processed for public distribution. As the fixes and features available on nightlies are still under testing and development, it may be used on production systems at your own risk.

== Working with SVN ==

Some basic SVN usage information can be found at the [[FCKeditor 2.x/Developers Guide/SVN/SVN Basics|SVN Basics]] page.

== Testing Old Revisions ==

There are occasions during the development, when bugs are introduced by recent changes in the code. To precisely understand and find when things changed, we have created a dedicated web site with a list of all revisions available for the trunk:

http://rev.fckeditor.net/

The list in the above site is quite similar to the [http://dev.fckeditor.net/log/FCKeditor/trunk trunk log page], with the exception that it contains and additional column called "Test". A link can be found there to open the sample pages of FCKeditor, generated for each precise revision.

== Repository Structure ==

<pre>
FCKeditor -----------+ Every subproject will have a directory in the root.
trunk -----------+ This is the development place.
branches
developers --+
features | Isolated development spaces.
versions ----+
tags
2.3.2 -------+
2.3.1 | A tag will be available for each version release.
2.3 | It contains the development version (trunk) at release time.
1.6.1 -------+
</pre>
All subprojects in the repository will present a structure similar to the above.

=== The "trunk" ===

The trunk is the effective place we'll be working everyday. Usually we'll have local working copies of the trunk only (and possibly any branch).

Starting from version 2.4, the trunk will always have stable code which we can publish to the public SVN, and eventually release officially. So, only important bugs and small changes will be committed here, while more delicate and extensive developments will be done in a "branch".

=== Branches ===

Branches give us isolated environments for development, and once tested and confirmed a new work is ready, it can be simply merged in the trunk.

For code that doesn't bring instability, like trivial fixes or small features, there is no need to work on a separated branch. It can be committed directly to the trunk if you feel the code is ok and it is well tested. It makes the management easier.

The branches could be created in the following spaces:

* '''branches/developers:''' each developer may have a private branch under this directory. The directory name is the developer name (fredck, for example). The developer himself can decide to use it or not, and have complete freedom for it.
* '''branches/features:''' if a feature is too big and complex, a developer could decide to create a dedicated branch for it.
* '''branches/versions:''' there could be branches for future versions, waiting while previous ones are being tested and released.

==== Merging Branches ====

A common task during a branch development, is to '''merge changes made in the trunk to the branch''', leaving it always up to date with the trunk. Remember that merges must be done from the last revision merged, starting from the revision from which the branch has been created.

When '''merging branches to the trunk''', first merge the trunk to the branch and check that everything is ok. Make the necessary changes and commit the branch. Then switch to the trunk and merge the differences between the branch HEAD and the last trunk revision you have just merged to the branch (usually HEAD). Then, if the branch is not anymore needed, just delete it (SVN delete I mean).

If you are insecure, don't be afraid of asking others to execute this task for you.

TortoiseSVN offers a nice tool to track the creation an life-cicle of branches. It is called "Revision graph". The SVN log can also be used for it.

== Committing ==

Try to make a single commit for each fix or feature. Avoid making big commits with lots of changes. This separation makes each commit an isolate thing. It makes code review and merge tasks easy.

The commit log message is very important. Don't underestimate it. It must be well written and informative. Whenever possible, make references to related trac items, like tickets or changesets. You may use one of the "standard" messages, like the following examples:

* Fixed [http://dev.fckeditor.net/ticket/81 #81]: IE has a DOM bug that caused FCKDomTools.RTrimNode to break.
* Merged trunk [http://dev.fckeditor.net/log/?rev=132&stop_rev=131 r131:132] into branches/versions/2.4.x
* FCKeditor 2.4 tagging

== Links ==

* '''TortoiseSVN:''' the SVN integration with the Windows Shell. This is the best way to work with SVN in Windows: http://tortoisesvn.tigris.org/
* '''Subversion:''' the official SVN command line. Windows binaries can be found in the download page: http://subversion.tigris.org/
* '''Book - Version Control with Subversion:''' a good book about SVN: http://svnbook.red-bean.com/

FCKeditor 2.x/Developers Guide/SVN

2008-01-23T10:22:56Z

W.olchawa:

== Development SVN ==

The SVN repository used for the development can be found at ([http://dev.fckeditor.net/browser browsable]):

http://svn.fckeditor.net

The SVN contains the "development version" of FCKeditor. It doesn't reflect the contents of public distributions. Actually, some files are not present in the public downloads (like the "_dev" folder or the compressed "js" files, for example).

'''We don't recommend using this version on production.''' There are also security implications on doing so. To make the SVN version "production safe", it must be processed with FCKreleaser (available inside _dev). A safer and easier option is to simply use the Nightly Build, which is already processed.

== Nightly Build ==

Every night, at 0:30 PST, a "'''Nightly Build'''" is generated, from the SVN version. You may download it from one of the following links:

* http://www.fckeditor.net/nightly/FCKeditor_N.zip
* http://www.fckeditor.net/nightly/FCKeditor_N.tar.gz

You may also test it online [http://www.fckeditor.net/nightly/fckeditor/_samples/default.html here].

The nightly is processed for public distribution. As the fixes and features available on nightlies are still under testing and development, it may be used on production systems at your own risk.

== Working with SVN ==

Some basic SVN usage information can be found at the [[FCKeditor 2.x/Developers Guide/SVN/SVN Basics|SVN Basics]] page.

== Testing Old Revisions ==

There are occasions during the development, when bugs are introduced by recent changes in the code. To precisely understand and find when things changed, we have created a dedicated web site with a list of all revisions available for the trunk:

http://rev.fckeditor.net/

The list in the above site is quite similar to the [http://dev.fckeditor.net/log/FCKeditor/trunk trunk log page], with the exception that it contains and additional column called "Test". A link can be found there to open the sample pages of FCKeditor, generated for each precise revision.

== Repository Structure ==

<pre>
FCKeditor -----------+ Every subproject will have a directory in the root.
trunk -----------+ This is the development place.
branches
developers --+
features | Isolated development spaces.
versions ----+
tags
2.3.2 -------+
2.3.1 | A tag will be available for each version release.
2.3 | It contains the development version (trunk) at release time.
1.6.1 -------+
</pre>
All subprojects in the repository will present a structure similar to the above.

=== The "trunk" ===

The trunk is the effective place we'll be working everyday. Usually we'll have local working copies of the trunk only (and possibly any branch).

Starting from version 2.4, the trunk will always have stable code which we can publish to the public SVN, and eventually release officially. So, only important bugs and small changes will be committed here, while more delicate and extensive developments will be done in a "branch".

=== Branches ===

Branches give us isolated environments for development, and once tested and confirmed a new work is ready, it can be simply merged in the trunk.

For code that doesn't bring instability, like trivial fixes or small features, there is no need to work on a separated branch. It can be committed directly to the trunk if you feel the code is ok and it is well tested. It makes the management easier.

The branches could be created in the following spaces:

* '''branches/developers:''' each developer may have a private branch under this directory. The directory name is the developer name (fredck, for example). The developer himself can decide to use it or not, and have complete freedom for it.
* '''branches/features:''' if a feature is too big and complex, a developer could decide to create a dedicated branch for it.
* '''branches/versions:''' there could be branches for future versions, waiting while previous ones are being tested and released.

==== Merging Branches ====

A common task during a branch development, is to '''merge changes made in the trunk to the branch''', leaving it always up to date with the trunk. Remember that merges must be done from the last revision merged, starting from the revision from which the branch has been created.

When '''merging branches to the trunk''', first merge the trunk to the branch and check that everything is ok. Make the necessary changes and commit the branch. Then switch to the trunk and merge the differences between the branch HEAD and the last trunk revision you have just merged to the branch (usually HEAD). Then, if the branch is not anymore needed, just delete it (SVN delete I mean).

If you are insecure, don't be afraid of asking others to execute this task for you.

TortoiseSVN offers a nice tool to track the creation an life-cicle of branches. It is called "Revision graph". The SVN log can also be used for it.

== Committing ==

Try to make a single commit for each fix or feature. Avoid making big commits with lots of changes. This separation makes each commit an isolate thing. It makes code review and merge tasks easy.

The commit log message is very important. Don't underestimate it. It must be well written and informative. Whenever possible, make references to related trac items, like tickets or changesets. You may use one of the "standard" messages, like the following examples:

* Fixed [http://dev.fckeditor.net/ticket/81| #81]: IE has a DOM bug that caused FCKDomTools.RTrimNode to break.
* Merged trunk [http://dev.fckeditor.net/log/?rev=132&stop_rev=131| r131:132] into branches/versions/2.4.x
* FCKeditor 2.4 tagging

== Links ==

* '''TortoiseSVN:''' the SVN integration with the Windows Shell. This is the best way to work with SVN in Windows: http://tortoisesvn.tigris.org/
* '''Subversion:''' the official SVN command line. Windows binaries can be found in the download page: http://subversion.tigris.org/
* '''Book - Version Control with Subversion:''' a good book about SVN: http://svnbook.red-bean.com/

FCKeditor 2.x/Developers Guide/SVN

2008-01-23T10:22:37Z

W.olchawa:

== Development SVN ==

The SVN repository used for the development can be found at ([http://dev.fckeditor.net/browser browsable]):

http://svn.fckeditor.net

The SVN contains the "development version" of FCKeditor. It doesn't reflect the contents of public distributions. Actually, some files are not present in the public downloads (like the "_dev" folder or the compressed "js" files, for example).

'''We don't recommend using this version on production.''' There are also security implications on doing so. To make the SVN version "production safe", it must be processed with FCKreleaser (available inside _dev). A safer and easier option is to simply use the Nightly Build, which is already processed.

== Nightly Build ==

Every night, at 0:30 PST, a "'''Nightly Build'''" is generated, from the SVN version. You may download it from one of the following links:

* http://www.fckeditor.net/nightly/FCKeditor_N.zip
* http://www.fckeditor.net/nightly/FCKeditor_N.tar.gz

You may also test it online [http://www.fckeditor.net/nightly/fckeditor/_samples/default.html here].

The nightly is processed for public distribution. As the fixes and features available on nightlies are still under testing and development, it may be used on production systems at your own risk.

== Working with SVN ==

Some basic SVN usage information can be found at the [[FCKeditor 2.x/Developers Guide/SVN/SVN Basics|SVN Basics]] page.

== Testing Old Revisions ==

There are occasions during the development, when bugs are introduced by recent changes in the code. To precisely understand and find when things changed, we have created a dedicated web site with a list of all revisions available for the trunk:

http://rev.fckeditor.net/

The list in the above site is quite similar to the [http://dev.fckeditor.net/log/FCKeditor/trunk| trunk log page], with the exception that it contains and additional column called "Test". A link can be found there to open the sample pages of FCKeditor, generated for each precise revision.

== Repository Structure ==

<pre>
FCKeditor -----------+ Every subproject will have a directory in the root.
trunk -----------+ This is the development place.
branches
developers --+
features | Isolated development spaces.
versions ----+
tags
2.3.2 -------+
2.3.1 | A tag will be available for each version release.
2.3 | It contains the development version (trunk) at release time.
1.6.1 -------+
</pre>
All subprojects in the repository will present a structure similar to the above.

=== The "trunk" ===

The trunk is the effective place we'll be working everyday. Usually we'll have local working copies of the trunk only (and possibly any branch).

Starting from version 2.4, the trunk will always have stable code which we can publish to the public SVN, and eventually release officially. So, only important bugs and small changes will be committed here, while more delicate and extensive developments will be done in a "branch".

=== Branches ===

Branches give us isolated environments for development, and once tested and confirmed a new work is ready, it can be simply merged in the trunk.

For code that doesn't bring instability, like trivial fixes or small features, there is no need to work on a separated branch. It can be committed directly to the trunk if you feel the code is ok and it is well tested. It makes the management easier.

The branches could be created in the following spaces:

* '''branches/developers:''' each developer may have a private branch under this directory. The directory name is the developer name (fredck, for example). The developer himself can decide to use it or not, and have complete freedom for it.
* '''branches/features:''' if a feature is too big and complex, a developer could decide to create a dedicated branch for it.
* '''branches/versions:''' there could be branches for future versions, waiting while previous ones are being tested and released.

==== Merging Branches ====

A common task during a branch development, is to '''merge changes made in the trunk to the branch''', leaving it always up to date with the trunk. Remember that merges must be done from the last revision merged, starting from the revision from which the branch has been created.

When '''merging branches to the trunk''', first merge the trunk to the branch and check that everything is ok. Make the necessary changes and commit the branch. Then switch to the trunk and merge the differences between the branch HEAD and the last trunk revision you have just merged to the branch (usually HEAD). Then, if the branch is not anymore needed, just delete it (SVN delete I mean).

If you are insecure, don't be afraid of asking others to execute this task for you.

TortoiseSVN offers a nice tool to track the creation an life-cicle of branches. It is called "Revision graph". The SVN log can also be used for it.

== Committing ==

Try to make a single commit for each fix or feature. Avoid making big commits with lots of changes. This separation makes each commit an isolate thing. It makes code review and merge tasks easy.

The commit log message is very important. Don't underestimate it. It must be well written and informative. Whenever possible, make references to related trac items, like tickets or changesets. You may use one of the "standard" messages, like the following examples:

* Fixed [http://dev.fckeditor.net/ticket/81| #81]: IE has a DOM bug that caused FCKDomTools.RTrimNode to break.
* Merged trunk [http://dev.fckeditor.net/log/?rev=132&stop_rev=131| r131:132] into branches/versions/2.4.x
* FCKeditor 2.4 tagging

== Links ==

* '''TortoiseSVN:''' the SVN integration with the Windows Shell. This is the best way to work with SVN in Windows: http://tortoisesvn.tigris.org/
* '''Subversion:''' the official SVN command line. Windows binaries can be found in the download page: http://subversion.tigris.org/
* '''Book - Version Control with Subversion:''' a good book about SVN: http://svnbook.red-bean.com/

FCKeditor 2.x/Developers Guide/SVN

2008-01-23T10:22:15Z

W.olchawa:

== Development SVN ==

The SVN repository used for the development can be found at ([http://dev.fckeditor.net/browser browsable]):

http://svn.fckeditor.net

The SVN contains the "development version" of FCKeditor. It doesn't reflect the contents of public distributions. Actually, some files are not present in the public downloads (like the "_dev" folder or the compressed "js" files, for example).

'''We don't recommend using this version on production.''' There are also security implications on doing so. To make the SVN version "production safe", it must be processed with FCKreleaser (available inside _dev). A safer and easier option is to simply use the Nightly Build, which is already processed.

== Nightly Build ==

Every night, at 0:30 PST, a "'''Nightly Build'''" is generated, from the SVN version. You may download it from one of the following links:

* http://www.fckeditor.net/nightly/FCKeditor_N.zip
* http://www.fckeditor.net/nightly/FCKeditor_N.tar.gz

You may also test it online [http://www.fckeditor.net/nightly/fckeditor/_samples/default.html: here].

The nightly is processed for public distribution. As the fixes and features available on nightlies are still under testing and development, it may be used on production systems at your own risk.

== Working with SVN ==

Some basic SVN usage information can be found at the [[FCKeditor 2.x/Developers Guide/SVN/SVN Basics|SVN Basics]] page.

== Testing Old Revisions ==

There are occasions during the development, when bugs are introduced by recent changes in the code. To precisely understand and find when things changed, we have created a dedicated web site with a list of all revisions available for the trunk:

http://rev.fckeditor.net/

The list in the above site is quite similar to the [http://dev.fckeditor.net/log/FCKeditor/trunk| trunk log page], with the exception that it contains and additional column called "Test". A link can be found there to open the sample pages of FCKeditor, generated for each precise revision.

== Repository Structure ==

<pre>
FCKeditor -----------+ Every subproject will have a directory in the root.
trunk -----------+ This is the development place.
branches
developers --+
features | Isolated development spaces.
versions ----+
tags
2.3.2 -------+
2.3.1 | A tag will be available for each version release.
2.3 | It contains the development version (trunk) at release time.
1.6.1 -------+
</pre>
All subprojects in the repository will present a structure similar to the above.

=== The "trunk" ===

The trunk is the effective place we'll be working everyday. Usually we'll have local working copies of the trunk only (and possibly any branch).

Starting from version 2.4, the trunk will always have stable code which we can publish to the public SVN, and eventually release officially. So, only important bugs and small changes will be committed here, while more delicate and extensive developments will be done in a "branch".

=== Branches ===

Branches give us isolated environments for development, and once tested and confirmed a new work is ready, it can be simply merged in the trunk.

For code that doesn't bring instability, like trivial fixes or small features, there is no need to work on a separated branch. It can be committed directly to the trunk if you feel the code is ok and it is well tested. It makes the management easier.

The branches could be created in the following spaces:

* '''branches/developers:''' each developer may have a private branch under this directory. The directory name is the developer name (fredck, for example). The developer himself can decide to use it or not, and have complete freedom for it.
* '''branches/features:''' if a feature is too big and complex, a developer could decide to create a dedicated branch for it.
* '''branches/versions:''' there could be branches for future versions, waiting while previous ones are being tested and released.

==== Merging Branches ====

A common task during a branch development, is to '''merge changes made in the trunk to the branch''', leaving it always up to date with the trunk. Remember that merges must be done from the last revision merged, starting from the revision from which the branch has been created.

When '''merging branches to the trunk''', first merge the trunk to the branch and check that everything is ok. Make the necessary changes and commit the branch. Then switch to the trunk and merge the differences between the branch HEAD and the last trunk revision you have just merged to the branch (usually HEAD). Then, if the branch is not anymore needed, just delete it (SVN delete I mean).

If you are insecure, don't be afraid of asking others to execute this task for you.

TortoiseSVN offers a nice tool to track the creation an life-cicle of branches. It is called "Revision graph". The SVN log can also be used for it.

== Committing ==

Try to make a single commit for each fix or feature. Avoid making big commits with lots of changes. This separation makes each commit an isolate thing. It makes code review and merge tasks easy.

The commit log message is very important. Don't underestimate it. It must be well written and informative. Whenever possible, make references to related trac items, like tickets or changesets. You may use one of the "standard" messages, like the following examples:

* Fixed [http://dev.fckeditor.net/ticket/81| #81]: IE has a DOM bug that caused FCKDomTools.RTrimNode to break.
* Merged trunk [http://dev.fckeditor.net/log/?rev=132&stop_rev=131| r131:132] into branches/versions/2.4.x
* FCKeditor 2.4 tagging

== Links ==

* '''TortoiseSVN:''' the SVN integration with the Windows Shell. This is the best way to work with SVN in Windows: http://tortoisesvn.tigris.org/
* '''Subversion:''' the official SVN command line. Windows binaries can be found in the download page: http://subversion.tigris.org/
* '''Book - Version Control with Subversion:''' a good book about SVN: http://svnbook.red-bean.com/

FCKeditor 2.x/Developers Guide/SVN

2008-01-23T10:20:52Z

W.olchawa:

== Development SVN ==

The SVN repository used for the development can be found at ([http://dev.fckeditor.net/browser: browsable]):

http://svn.fckeditor.net

The SVN contains the "development version" of FCKeditor. It doesn't reflect the contents of public distributions. Actually, some files are not present in the public downloads (like the "_dev" folder or the compressed "js" files, for example).

'''We don't recommend using this version on production.''' There are also security implications on doing so. To make the SVN version "production safe", it must be processed with FCKreleaser (available inside _dev). A safer and easier option is to simply use the Nightly Build, which is already processed.

== Nightly Build ==

Every night, at 0:30 PST, a "'''Nightly Build'''" is generated, from the SVN version. You may download it from one of the following links:

* http://www.fckeditor.net/nightly/FCKeditor_N.zip
* http://www.fckeditor.net/nightly/FCKeditor_N.tar.gz

You may also test it online [http://www.fckeditor.net/nightly/fckeditor/_samples/default.html: here].

The nightly is processed for public distribution. As the fixes and features available on nightlies are still under testing and development, it may be used on production systems at your own risk.

== Working with SVN ==

Some basic SVN usage information can be found at the [[FCKeditor 2.x/Developers Guide/SVN/SVN Basics|SVN Basics]] page.

== Testing Old Revisions ==

There are occasions during the development, when bugs are introduced by recent changes in the code. To precisely understand and find when things changed, we have created a dedicated web site with a list of all revisions available for the trunk:

http://rev.fckeditor.net/

The list in the above site is quite similar to the [http://dev.fckeditor.net/log/FCKeditor/trunk| trunk log page], with the exception that it contains and additional column called "Test". A link can be found there to open the sample pages of FCKeditor, generated for each precise revision.

== Repository Structure ==

<pre>
FCKeditor -----------+ Every subproject will have a directory in the root.
trunk -----------+ This is the development place.
branches
developers --+
features | Isolated development spaces.
versions ----+
tags
2.3.2 -------+
2.3.1 | A tag will be available for each version release.
2.3 | It contains the development version (trunk) at release time.
1.6.1 -------+
</pre>
All subprojects in the repository will present a structure similar to the above.

=== The "trunk" ===

The trunk is the effective place we'll be working everyday. Usually we'll have local working copies of the trunk only (and possibly any branch).

Starting from version 2.4, the trunk will always have stable code which we can publish to the public SVN, and eventually release officially. So, only important bugs and small changes will be committed here, while more delicate and extensive developments will be done in a "branch".

=== Branches ===

Branches give us isolated environments for development, and once tested and confirmed a new work is ready, it can be simply merged in the trunk.

For code that doesn't bring instability, like trivial fixes or small features, there is no need to work on a separated branch. It can be committed directly to the trunk if you feel the code is ok and it is well tested. It makes the management easier.

The branches could be created in the following spaces:

* '''branches/developers:''' each developer may have a private branch under this directory. The directory name is the developer name (fredck, for example). The developer himself can decide to use it or not, and have complete freedom for it.
* '''branches/features:''' if a feature is too big and complex, a developer could decide to create a dedicated branch for it.
* '''branches/versions:''' there could be branches for future versions, waiting while previous ones are being tested and released.

==== Merging Branches ====

A common task during a branch development, is to '''merge changes made in the trunk to the branch''', leaving it always up to date with the trunk. Remember that merges must be done from the last revision merged, starting from the revision from which the branch has been created.

When '''merging branches to the trunk''', first merge the trunk to the branch and check that everything is ok. Make the necessary changes and commit the branch. Then switch to the trunk and merge the differences between the branch HEAD and the last trunk revision you have just merged to the branch (usually HEAD). Then, if the branch is not anymore needed, just delete it (SVN delete I mean).

If you are insecure, don't be afraid of asking others to execute this task for you.

TortoiseSVN offers a nice tool to track the creation an life-cicle of branches. It is called "Revision graph". The SVN log can also be used for it.

== Committing ==

Try to make a single commit for each fix or feature. Avoid making big commits with lots of changes. This separation makes each commit an isolate thing. It makes code review and merge tasks easy.

The commit log message is very important. Don't underestimate it. It must be well written and informative. Whenever possible, make references to related trac items, like tickets or changesets. You may use one of the "standard" messages, like the following examples:

* Fixed [http://dev.fckeditor.net/ticket/81| #81]: IE has a DOM bug that caused FCKDomTools.RTrimNode to break.
* Merged trunk [http://dev.fckeditor.net/log/?rev=132&stop_rev=131| r131:132] into branches/versions/2.4.x
* FCKeditor 2.4 tagging

== Links ==

* '''TortoiseSVN:''' the SVN integration with the Windows Shell. This is the best way to work with SVN in Windows: http://tortoisesvn.tigris.org/
* '''Subversion:''' the official SVN command line. Windows binaries can be found in the download page: http://subversion.tigris.org/
* '''Book - Version Control with Subversion:''' a good book about SVN: http://svnbook.red-bean.com/

FCKeditor 2.x/Developers Guide/SVN/SVN Basics

2008-01-23T10:19:57Z

W.olchawa:

== SVN Basics ==

[http://subversion.tigris.org/| Subversion] (SVN) is a version control system. It is designed to be distributed, concurrent and expandable.

[http://svnbook.red-bean.com/| Version Control with Subversion] is a wonderful book to help on making the first steps inside Subversion. You may also ready it online.

=== SVN Client ===

To work on the FCKeditor SVN, you need a '''SVN client''' software. There are two options that we recommend:

* [http://tortoisesvn.sourceforge.net/| TortoiseSVN] (strongly recommended), for Microsoft Windows.
* [http://subversion.tigris.org/| The official SVN client], included in most Linux and BSD distributions; available for Linux, BSD, Mac OS X, and Windows.

=== Checkout the FCKeditor trunk ===

FCKeditor 2.x/Developers Guide/SVN/SVN Basics

2008-01-23T10:19:36Z

W.olchawa: New page: == SVN Basics == [http://subversion.tigris.org/| Subversion] (SVN) is a version control system. It is designed to be distributed, concurrent and expandable. [http://svnbook.red-bean.com/...

== SVN Basics ==

[http://subversion.tigris.org/| Subversion] (SVN) is a version control system. It is designed to be distributed, concurrent and expandable.

[http://svnbook.red-bean.com/| Version Control with Subversion] is a wonderful book to help on making the first steps inside Subversion. You may also ready it online.

=== SVN Client ===

To work on the FCKeditor SVN, you need a '''SVN client''' software. There are two options that we recommend:
* [http://tortoisesvn.sourceforge.net/| TortoiseSVN (strongly recommended), for Microsoft Windows.
* [http://subversion.tigris.org/| The official SVN client], included in most Linux and BSD distributions; available for Linux, BSD, Mac OS X, and Windows.

=== Checkout the FCKeditor trunk ===

FCKeditor 2.x/Developers Guide/SVN

2008-01-23T10:15:05Z

W.olchawa:

== Development SVN ==

The SVN repository used for the development can be found at ([http://dev.fckeditor.net/browser: browsable]):

http://svn.fckeditor.net

The SVN contains the "development version" of FCKeditor. It doesn't reflect the contents of public distributions. Actually, some files are not present in the public downloads (like the "_dev" folder or the compressed "js" files, for example).

'''We don't recommend using this version on production.''' There are also security implications on doing so. To make the SVN version "production safe", it must be processed with FCKreleaser (available inside _dev). A safer and easier option is to simply use the Nightly Build, which is already processed.

== Nightly Build ==

Every night, at 0:30 PST, a "'''Nightly Build'''" is generated, from the SVN version. You may download it from one of the following links:
* http://www.fckeditor.net/nightly/FCKeditor_N.zip
* http://www.fckeditor.net/nightly/FCKeditor_N.tar.gz
You may also test it online [http://www.fckeditor.net/nightly/fckeditor/_samples/default.html| here].

The nightly is processed for public distribution. As the fixes and features available on nightlies are still under testing and development, it may be used on production systems at your own risk.

== Working with SVN ==

Some basic SVN usage information can be found at the [[FCKeditor 2.x/Developers Guide/SVN/SVN Basics|SVN Basics]] page.

== Testing Old Revisions ==

There are occasions during the development, when bugs are introduced by recent changes in the code. To precisely understand and find when things changed, we have created a dedicated web site with a list of all revisions available for the trunk:

http://rev.fckeditor.net/

The list in the above site is quite similar to the [http://dev.fckeditor.net/log/FCKeditor/trunk| trunk log page], with the exception that it contains and additional column called "Test". A link can be found there to open the sample pages of FCKeditor, generated for each precise revision.

== Repository Structure ==

<pre>
FCKeditor -----------+ Every subproject will have a directory in the root.
trunk -----------+ This is the development place.
branches
developers --+
features | Isolated development spaces.
versions ----+
tags
2.3.2 -------+
2.3.1 | A tag will be available for each version release.
2.3 | It contains the development version (trunk) at release time.
1.6.1 -------+
</pre>
All subprojects in the repository will present a structure similar to the above.

=== The "trunk" ===

The trunk is the effective place we'll be working everyday. Usually we'll have local working copies of the trunk only (and possibly any branch).

Starting from version 2.4, the trunk will always have stable code which we can publish to the public SVN, and eventually release officially. So, only important bugs and small changes will be committed here, while more delicate and extensive developments will be done in a "branch".

=== Branches ===

Branches give us isolated environments for development, and once tested and confirmed a new work is ready, it can be simply merged in the trunk.

For code that doesn't bring instability, like trivial fixes or small features, there is no need to work on a separated branch. It can be committed directly to the trunk if you feel the code is ok and it is well tested. It makes the management easier.

The branches could be created in the following spaces:

* '''branches/developers:''' each developer may have a private branch under this directory. The directory name is the developer name (fredck, for example). The developer himself can decide to use it or not, and have complete freedom for it.
* '''branches/features:''' if a feature is too big and complex, a developer could decide to create a dedicated branch for it.
* '''branches/versions:''' there could be branches for future versions, waiting while previous ones are being tested and released.

==== Merging Branches ====

A common task during a branch development, is to '''merge changes made in the trunk to the branch''', leaving it always up to date with the trunk. Remember that merges must be done from the last revision merged, starting from the revision from which the branch has been created.

When '''merging branches to the trunk''', first merge the trunk to the branch and check that everything is ok. Make the necessary changes and commit the branch. Then switch to the trunk and merge the differences between the branch HEAD and the last trunk revision you have just merged to the branch (usually HEAD). Then, if the branch is not anymore needed, just delete it (SVN delete I mean).

If you are insecure, don't be afraid of asking others to execute this task for you.

TortoiseSVN offers a nice tool to track the creation an life-cicle of branches. It is called "Revision graph". The SVN log can also be used for it.

== Committing ==

Try to make a single commit for each fix or feature. Avoid making big commits with lots of changes. This separation makes each commit an isolate thing. It makes code review and merge tasks easy.

The commit log message is very important. Don't underestimate it. It must be well written and informative. Whenever possible, make references to related trac items, like tickets or changesets. You may use one of the "standard" messages, like the following examples:

* Fixed [http://dev.fckeditor.net/ticket/81| #81]: IE has a DOM bug that caused FCKDomTools.RTrimNode to break.
* Merged trunk [http://dev.fckeditor.net/log/?rev=132&stop_rev=131| r131:132] into branches/versions/2.4.x
* FCKeditor 2.4 tagging

== Links ==

* '''TortoiseSVN:''' the SVN integration with the Windows Shell. This is the best way to work with SVN in Windows: http://tortoisesvn.tigris.org/
* '''Subversion:''' the official SVN command line. Windows binaries can be found in the download page: http://subversion.tigris.org/
* '''Book - Version Control with Subversion:''' a good book about SVN: http://svnbook.red-bean.com/

FCKeditor 2.x/Developers Guide/SVN

2008-01-23T10:14:05Z

W.olchawa:

== Development SVN ==

The SVN repository used for the development can be found at ([http://dev.fckeditor.net/browser: browsable]):

http://svn.fckeditor.net

The SVN contains the "development version" of FCKeditor. It doesn't reflect the contents of public distributions. Actually, some files are not present in the public downloads (like the "_dev" folder or the compressed "js" files, for example).

'''We don't recommend using this version on production.''' There are also security implications on doing so. To make the SVN version "production safe", it must be processed with FCKreleaser (available inside _dev). A safer and easier option is to simply use the Nightly Build, which is already processed.

== Nightly Build ==

Every night, at 0:30 PST, a "'''Nightly Build'''" is generated, from the SVN version. You may download it from one of the following links:
* http://www.fckeditor.net/nightly/FCKeditor_N.zip
* http://www.fckeditor.net/nightly/FCKeditor_N.tar.gz
You may also test it online [http://www.fckeditor.net/nightly/fckeditor/_samples/default.html| here].

The nightly is processed for public distribution. As the fixes and features available on nightlies are still under testing and development, it may be used on production systems at your own risk.

== Working with SVN ==

Some basic SVN usage information can be found at the [[FCKeditor 2.x/Developers Guide/SVN/SVN Basics|SVN Basics]] page.

== Testing Old Revisions ==

There are occasions during the development, when bugs are introduced by recent changes in the code. To precisely understand and find when things changed, we have created a dedicated web site with a list of all revisions available for the trunk:

http://rev.fckeditor.net/

The list in the above site is quite similar to the [http://dev.fckeditor.net/log/FCKeditor/trunk| trunk log page], with the exception that it contains and additional column called "Test". A link can be found there to open the sample pages of FCKeditor, generated for each precise revision.

== Repository Structure ==

<pre>
FCKeditor -----------+ Every subproject will have a directory in the root.
trunk -----------+ This is the development place.
branches
developers --+
features | Isolated development spaces.
versions ----+
tags
2.3.2 -------+
2.3.1 | A tag will be available for each version release.
2.3 | It contains the development version (trunk) at release time.
1.6.1 -------+
</pre>
All subprojects in the repository will present a structure similar to the above.

=== The "trunk" ===

The trunk is the effective place we'll be working everyday. Usually we'll have local working copies of the trunk only (and possibly any branch).

Starting from version 2.4, the trunk will always have stable code which we can publish to the public SVN, and eventually release officially. So, only important bugs and small changes will be committed here, while more delicate and extensive developments will be done in a "branch".

=== Branches ===

Branches give us isolated environments for development, and once tested and confirmed a new work is ready, it can be simply merged in the trunk.

For code that doesn't bring instability, like trivial fixes or small features, there is no need to work on a separated branch. It can be committed directly to the trunk if you feel the code is ok and it is well tested. It makes the management easier.

The branches could be created in the following spaces:

* '''branches/developers:''' each developer may have a private branch under this directory. The directory name is the developer name (fredck, for example). The developer himself can decide to use it or not, and have complete freedom for it.
* '''branches/features:''' if a feature is too big and complex, a developer could decide to create a dedicated branch for it.
* '''branches/versions:''' there could be branches for future versions, waiting while previous ones are being tested and released.

==== Merging Branches ====

A common task during a branch development, is to '''merge changes made in the trunk to the branch''', leaving it always up to date with the trunk. Remember that merges must be done from the last revision merged, starting from the revision from which the branch has been created.

When '''merging branches to the trunk''', first merge the trunk to the branch and check that everything is ok. Make the necessary changes and commit the branch. Then switch to the trunk and merge the differences between the branch HEAD and the last trunk revision you have just merged to the branch (usually HEAD). Then, if the branch is not anymore needed, just delete it (SVN delete I mean).

If you are insecure, don't be afraid of asking others to execute this task for you.

TortoiseSVN offers a nice tool to track the creation an life-cicle of branches. It is called "Revision graph". The SVN log can also be used for it.

== Committing ==

Try to make a single commit for each fix or feature. Avoid making big commits with lots of changes. This separation makes each commit an isolate thing. It makes code review and merge tasks easy.

The commit log message is very important. Don't underestimate it. It must be well written and informative. Whenever possible, make references to related trac items, like tickets or changesets. You may use one of the "standard" messages, like the following examples:

* Fixed [http://dev.fckeditor.net/ticket/81| #81]: IE has a DOM bug that caused FCKDomTools.RTrimNode to break.
* Merged trunk [http://dev.fckeditor.net/log/?rev=132&stop_rev=131| r131:132] into branches/versions/2.4.x
* FCKeditor 2.4 tagging

== Links ==

* '''TortoiseSVN:''' the SVN integration with the Windows Shell. This is the best way to work with SVN in Windows:

http://tortoisesvn.tigris.org/

* '''Subversion:''' the official SVN command line. Windows binaries can be found in the download page:

http://subversion.tigris.org/

* '''Book - Version Control with Subversion:''' a good book about SVN:

http://svnbook.red-bean.com/

FCKeditor 2.x/Developers Guide/SVN

2008-01-23T10:08:08Z

W.olchawa:

FCKeditor 2.x/Developers Guide/SVN

2008-01-23T10:05:47Z

W.olchawa:

FCKeditor 2.x/Developers Guide/SVN

2008-01-23T10:04:24Z

W.olchawa:

FCKeditor 2.x/Developers Guide/SVN

2008-01-23T09:54:54Z

W.olchawa: New page: == Subversion (SVN) Access ==

== Subversion (SVN) Access ==

FCKeditor 2.x/Developers Guide

2008-01-23T09:49:48Z

W.olchawa:

* [[FCKeditor 2.x/Developers Guide/Overview|Overview]]
* [[FCKeditor 2.x/Developers Guide/License|License]]
* [[FCKeditor 2.x/Developers Guide/Installation|Installation]]
** [[FCKeditor 2.x/Developers Guide/Installation/Upgrading|Upgrading]]
* Integration
** [[FCKeditor 2.x/Developers Guide/Integration/JavaScript|JavaScript]]
** [[FCKeditor 2.x/Developers Guide/Integration/AFP|AFP]]
** [[FCKeditor 2.x/Developers Guide/Integration/ASP|ASP]]
** [[FCKeditor 2.x/Developers Guide/Integration/ASP.NET|ASP.NET]]
** [[FCKeditor 2.x/Developers Guide/Integration/ColdFusion|ColdFusion]]
** [[FCKeditor 2.x/Developers Guide/Integration/Java|Java]]
** [[FCKeditor 2.x/Developers Guide/Integration/PHP|PHP]]
** [[FCKeditor 2.x/Developers Guide/Integration/Python|Python]]
** [[FCKeditor 2.x/Developers Guide/Integration/Other|Other]]
* Configuration
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration File|Configuration File]]
*** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options|Configuration Options]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Toolbar|Toolbar]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Styles|Styles]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Templates|Templates]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Spell Checker|Spell Checker]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Built in File Browser|Built in File Browser]]
* Customization
** [[FCKeditor 2.x/Developers Guide/Customization/Plug-ins|Plug-ins]]
** [[FCKeditor 2.x/Developers Guide/Customization/Scripts Compression|Scripts Compression]]
** [[FCKeditor 2.x/Developers Guide/Customization/Skins|Skins]]
** [[FCKeditor 2.x/Developers Guide/Customization/Custom File Browser|Custom File Browser]]
** [[FCKeditor 2.x/Developers Guide/Customization/Debugging|Debugging]]
* [[FCKeditor 2.x/Developers Guide/Deployment|Deployment]]
* [[FCKeditor 2.x/Developers Guide/SVN|Subversion (SVN) Access]]
* [[FCKeditor 2.x/Developers Guide/JavaScript API|FCKeditor JavaScript API]]
* Contributing
** [[FCKeditor 2.x/Developers Guide/Server Side Integration|Server Side Integration]]
** [[FCKeditor 2.x/Developers Guide/Localization|Localization]]
** [[FCKeditor 2.x/Developers Guide/Developer's Web Site|Developer's Web Site]]
* [[FCKeditor 2.x/Developers Guide/FAQ|FAQ - Frequently Asked Questions]]
* [[FCKeditor 2.x/Developers Guide/Troubleshooting|Troubleshooting]]

TODO

2008-01-23T09:47:05Z

W.olchawa:

== Site ==

* <strike>Remove "index.php" from the URL.</strike>

Followed by: http://www.mediawiki.org/wiki/Manual:Short_URL/wiki.example.com/Page_title--Enabling_a_wiki_using_Apache_Rewrite

* <strike>Possibly point the root ("/") to [[Main Page|Main_Page]], redirecting the logo and the navigation box to it.</strike>

skins/MonoBook.php add in line 73:
<pre><?php $this->data['nav_urls']['mainpage']['href'] = "/"; ?></pre>
skins/MonoBook.php, line 161, replace:
<pre><?php echo htmlspecialchars($val['href']) ?></pre>
with:
<pre><?php echo ($val['href'] == "/Main_Page") ? "/" : htmlspecialchars($val['href']); ?></pre>
* <strike>Remove the PDF extension.</strike>

Commented out
<pre>require_once $IP . "/extensions/wikipdf/wikipdf.php";</pre>
in LocalSettings.php

== FCKeditor 2.x - [[FCKeditor 2.x/Users Guide|User's Guide]] ==

* <strike>Create "Introduction to the User's Guide" as the first section in the guide.</strike> (needs review) 
* <strike>Replace textual examples with screenshots.</strike> 
* <strike>In</strike>[[FCKeditor 2.x/Users Guide/Other Tasks/Spell Checking|<strike>Spell Checking</strike>]]<strike>, introduce ieSpell, explaining the the spell checker depends on the editor settings.</strike>(need review) 
* <strike>In</strike>[[FCKeditor 2.x/Users Guide/Compatibility|<strike>Compatibility</strike>]]<strike>add a section for "Incompatible Browsers", explaining what happens on those browsers intead. (need review)</strike>
* <strike>"Anchors, Links and E-Mails" should be renamed to "Links, E-Mails and Anchors" (most used first). The page structure should follow the same order.</strike> 
* <strike>Rearange the Formatting page using this order:</strike>
** <strike>Bold, italic, underlined </strike>
** <strike>Styles </strike>
** <strike>Text layout and format </strike>
** <strike>Fonts </strike>
** <strike>Size and color </strike>
** <strike>Subscript and superscript </strike>
** <strike>Templates</strike>
* <strike>Move "Templates" from</strike>[[FCKeditor 2.x/Users Guide/Common Tasks/Text Formatting|<strike>Text Formatting</strike>]]<strike>to a dedicated section</strike>. 
* <strike>In</strike>[[FCKeditor 2.x/Users Guide/Interface/Context Menu|<strike>Context Menu</strike>]]<strike>, use the standard screenshot box for the example, possibly containing a text with a link, and the context menu for the link (it's a little bit richer).</strike>
* The HTML samplein the [[FCKeditor 2.x/Users Guide/Source Editor|Source Editor]] page is wrong. The link is out of the tag. It should be This is my standard text written in the <a href="http://www.fckeditor.net">FCKeditor. 

== CKFinder - [[CKFinder/Users Guide/Configuration|Configuration]] ==

* <strike>Quick Start (enabling, license, baseUrl, baseDir)</strike>
* <strike>Access Control</strike>
* <strike>Images</strike>
** <strike>Thumbnails</strike>
** <strike>Scaling</strike>
* <strike>Resource Types</strike>
** <strike>Built-in resource types (and their relation to FCKeditor)</strike>
** <strike>Adding new resource type</strike>
* <strike>Security</strike>
** <strike>Double File Extension (Apache issue)</strike>
** <strike>Image Uploads (validating image size)</strike>
** <strike>Html Extensions (to prevent against XSS File Header injection)</strike>
* <strike>Miscelanous (actually for now in PHP only: PHP doesn't support UTF-8 natively, that's why FilesystemEncoding exists in config.php. Linux stores file names as UTF-8, so we are ok there... but on Windows we have more complicated situation. Try to upload files with chinese and polish characters. Change FilesystemEncoding to see the difference (Make sure that you have enabled iconv in php.ini - modify xampp/apache/bin/php.ini + restart Apache)). For example on my Computer (Win XP/SP2 PL), creating and deleting folder named "żółtko" is possible only with FilesystemEncoding set to CP1250.</strike>

I<strike>n the example with three roles (admin, user, guest)</strike>[[CKFinder/Developers Guide/CKFinder Configuration/PHP/Access Control|<strike>Access Control</strike>]]<strike>the default configuration should be to '''deny''' everything.</strike> 

* Actually, we have to change it. Separate function is now used to authenticate user. So default permissions to allow everything to everyone remained. We should remove the wrong examples and give instead something less complicated: All other connectors could have something similar: [[CKFinder/Developers Guide/PHP/Configuration/Access Control|Developers_Guide/PHP/Configuration/Access_Control]] 
* We should warn users about direct access to files via URL. 

* <strike>CKFinder for ASP.NET i snot anymore using an XML file for the configurations. It uses now config.ascx, so the documentation must be changed to reflect it.</strike><strike></strike>

== FCKeditor - [[FCKeditor 2.x/Developers Guide|Developers Guide]] ==

* <strike>write the descriptions of some of the configuration option left :</strike>[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options|<strike>Configuration Options</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/EditorAreaStyles|<strike>EditorAreaStyles</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/RemoveFormatTags|<strike>RemoveFormatTags</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/HtmlEncodeOutput|<strike>HtmlEncodeOutput</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/IgnoreEmptyParagraphValue|<strike>IgnoreEmptyParagraphValue</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/DisableFFTableHandles|<strike>DisableFFTableHandles</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FloatingPanelsZIndex|<strike>FloatingPanelsZIndex</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ShowDropDialog|<strike>ShowDropDialog</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ToolbarLocation|<strike>ToolbarLocation</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/AllowQueryStringDebug|<strike>AllowQueryStringDebug</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/PreloadImages|<strike>PreloadImages</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkBrowserURL|<strike>LinkBrowserURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageBrowserURL|<strike>ImageBrowserURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashBrowserURL|<strike>FlashBrowserURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkUploadURL|<strike>LinkUploadURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageUploadURL|<strike>ImageUploadURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashUploadURL|<strike>FlashUploadURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/SpellerPagesServerScript|<strike>SpellerPagesServerScript</strike>]]
* also the configuration option should be categorized
* write the Debug and Debug Object section of the [[FCKeditor 2.x/Developers Guide/Customization/Debugging|Debugging]] page
* review the guide for links that should appear in the text linking to sections which weren't build yet
** I found that in [[FCKeditor 2.x/Developers Guide/Installation/Upgrading|Upgrading]] there's a link to the SVN section. We must detrmine if the SVN section should be build or not
* actually this is more a wiki issue: some sample code can't be applied to the site because of the wiki security settings which sometimes unables to write a full example in the instruction. E.g.[[FCKeditor 2.x/Developers Guide/Integration/AFP#Handling the posted data|AFP - handling the posted data]]. We should work it out somehow.

TODO

2008-01-23T09:26:26Z

W.olchawa:

== Site ==

* <strike>Remove "index.php" from the URL.</strike>

Followed by: http://www.mediawiki.org/wiki/Manual:Short_URL/wiki.example.com/Page_title--Enabling_a_wiki_using_Apache_Rewrite

* <strike>Possibly point the root ("/") to [[Main Page|Main_Page]], redirecting the logo and the navigation box to it.</strike>

skins/MonoBook.php add in line 73:
<pre><?php $this->data['nav_urls']['mainpage']['href'] = "/"; ?></pre>
skins/MonoBook.php, line 161, replace:
<pre><?php echo htmlspecialchars($val['href']) ?></pre>
with:
<pre><?php echo ($val['href'] == "/Main_Page") ? "/" : htmlspecialchars($val['href']); ?></pre>
* <strike>Remove the PDF extension.</strike>

Commented out
<pre>require_once $IP . "/extensions/wikipdf/wikipdf.php";</pre>
in LocalSettings.php

== FCKeditor 2.x - [[FCKeditor 2.x/Users Guide|User's Guide]] ==

* <strike>Create "Introduction to the User's Guide" as the first section in the guide.</strike> (needs review) 
* <strike>Replace textual examples with screenshots.</strike> 
* <strike>In</strike>[[FCKeditor 2.x/Users Guide/Other Tasks/Spell Checking|<strike>Spell Checking</strike>]]<strike>, introduce ieSpell, explaining the the spell checker depends on the editor settings.</strike>(need review) 
* <strike>In</strike>[[FCKeditor 2.x/Users Guide/Compatibility|<strike>Compatibility</strike>]]<strike>add a section for "Incompatible Browsers", explaining what happens on those browsers intead. (need review)</strike>
* <strike>"Anchors, Links and E-Mails" should be renamed to "Links, E-Mails and Anchors" (most used first). The page structure should follow the same order.</strike> 
* <strike>Rearange the Formatting page using this order:</strike>
** <strike>Bold, italic, underlined </strike>
** <strike>Styles </strike>
** <strike>Text layout and format </strike>
** <strike>Fonts </strike>
** <strike>Size and color </strike>
** <strike>Subscript and superscript </strike>
** <strike>Templates</strike>
* <strike>Move "Templates" from</strike>[[FCKeditor 2.x/Users Guide/Common Tasks/Text Formatting|<strike>Text Formatting</strike>]]<strike>to a dedicated section</strike>. 
* <strike>In</strike>[[FCKeditor 2.x/Users Guide/Interface/Context Menu|<strike>Context Menu</strike>]]<strike>, use the standard screenshot box for the example, possibly containing a text with a link, and the context menu for the link (it's a little bit richer).</strike>
* The HTML samplein the [[FCKeditor 2.x/Users Guide/Source Editor|Source Editor]] page is wrong. The link is out of the tag. It should be This is my standard text written in the <a href="http://www.fckeditor.net">FCKeditor. 

== CKFinder - [[CKFinder/Users Guide/Configuration|Configuration]] ==

* <strike>Quick Start (enabling, license, baseUrl, baseDir)</strike>
* <strike>Access Control</strike>
* <strike>Images</strike>
** <strike>Thumbnails</strike>
** <strike>Scaling</strike>
* <strike>Resource Types</strike>
** <strike>Built-in resource types (and their relation to FCKeditor)</strike>
** <strike>Adding new resource type</strike>
* <strike>Security</strike>
** <strike>Double File Extension (Apache issue)</strike>
** <strike>Image Uploads (validating image size)</strike>
** <strike>Html Extensions (to prevent against XSS File Header injection)</strike>
* <strike>Miscelanous (actually for now in PHP only: PHP doesn't support UTF-8 natively, that's why FilesystemEncoding exists in config.php. Linux stores file names as UTF-8, so we are ok there... but on Windows we have more complicated situation. Try to upload files with chinese and polish characters. Change FilesystemEncoding to see the difference (Make sure that you have enabled iconv in php.ini - modify xampp/apache/bin/php.ini + restart Apache)). For example on my Computer (Win XP/SP2 PL), creating and deleting folder named "żółtko" is possible only with FilesystemEncoding set to CP1250.</strike>

I<strike>n the example with three roles (admin, user, guest)</strike>[[CKFinder/Developers Guide/CKFinder Configuration/PHP/Access Control|<strike>Access Control</strike>]]<strike>the default configuration should be to '''deny''' everything.</strike> 

* Actually, we have to change it. Separate function is now used to authenticate user. So default permissions to allow everything to everyone remained. We should remove the wrong examples and give instead something less complicated: All other connectors could have something similar: [[CKFinder/Developers Guide/PHP/Configuration/Access Control|Developers_Guide/PHP/Configuration/Access_Control]] 
* We should warn users about direct access to files via URL. 

* <strike>CKFinder for ASP.NET i snot anymore using an XML file for the configurations. It uses now config.ascx, so the documentation must be changed to reflect it.</strike><strike></strike>

== FCKeditor - [[FCKeditor 2.x/Developers Guide|Developers Guide]] ==

* <strike>write the descriptions of some of the configuration option left :</strike>[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options|<strike>Configuration Options</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/EditorAreaStyles|<strike>EditorAreaStyles</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/RemoveFormatTags|<strike>RemoveFormatTags</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/HtmlEncodeOutput|<strike>HtmlEncodeOutput</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/IgnoreEmptyParagraphValue|<strike>IgnoreEmptyParagraphValue</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/DisableFFTableHandles|<strike>DisableFFTableHandles</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FloatingPanelsZIndex|<strike>FloatingPanelsZIndex</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ShowDropDialog|<strike>ShowDropDialog</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ToolbarLocation|<strike>ToolbarLocation</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/AllowQueryStringDebug|<strike>AllowQueryStringDebug</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/PreloadImages|<strike>PreloadImages</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkBrowserURL|<strike>LinkBrowserURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageBrowserURL|<strike>ImageBrowserURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashBrowserURL|<strike>FlashBrowserURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkUploadURL|<strike>LinkUploadURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageUploadURL|<strike>ImageUploadURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashUploadURL|<strike>FlashUploadURL</strike>]]
** [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/SpellerPagesServerScript|<strike>SpellerPagesServerScript</strike>]]
* also the configuration option should be categorized
* write the Debug and Debug Object section of the [[FCKeditor 2.x/Developers Guide/Customization/Debugging|Debugging]] page
* review the guide for links that should appear in the text linking to sections which weren't build yet
* actually this is more a wiki issue: some sample code can't be applied to the site because of the wiki security settings which sometimes unables to write a full example in the instruction. E.g.[[FCKeditor 2.x/Developers Guide/Integration/AFP#Handling the posted data|AFP - handling the posted data]]. We should work it out somehow.

FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/SpellerPagesServerScript

2008-01-23T09:25:05Z

W.olchawa: New page: When setting SpellChecker to "SpellerPages", it points to the URL for the server side script that handle...

When setting [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/SpellChecker|SpellChecker]] to "SpellerPages", it points to the URL for the server side script that handles Speller Pages:
<pre>
FCKConfig.SpellerPagesServerScript = 'server-scripts/spellchecker.php'
</pre>
Usually only the extension is changed to "php", "cfm" or "pl".

FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashUploadURL

2008-01-23T09:21:12Z

W.olchawa: New page: == FlashUploadURL == This option defines the URL to post files through the "Upload Tab" in the flash dialog. It can point to the default file uploader: <pre>FCKConfig.FlashUploadURL = FCK...

== FlashUploadURL ==

This option defines the URL to post files through the "Upload Tab" in the flash dialog. It can point to the default file uploader:
<pre>FCKConfig.FlashUploadURL = FCKConfig.BasePath + 'filemanager/connectors/' + _QuickUploadLanguage + '/upload.' + _QuickUploadExtension ;
</pre>
or any custom implementation of it:
<pre>FCKConfig.FlashUploadURL = '/myuploader/upload.php';
</pre>

FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageUploadURL

2008-01-23T09:20:27Z

W.olchawa: New page: == ImageUploadURL == This option defines the URL to post files through the "Upload Tab" in the image dialog. It can point to the default file uploader: <pre>FCKConfig.ImageUploadURL = FCK...

== ImageUploadURL ==

This option defines the URL to post files through the "Upload Tab" in the image dialog. It can point to the default file uploader:
<pre>FCKConfig.ImageUploadURL = FCKConfig.BasePath + 'filemanager/connectors/' + _QuickUploadLanguage + '/upload.' + _QuickUploadExtension ;
</pre>
or any custom implementation of it:
<pre>FCKConfig.ImageUploadURL = '/myuploader/upload.php';
</pre>

FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkUploadURL

2008-01-23T09:19:12Z

W.olchawa: New page: == LinkUploadURL == This option defines the URL to post files through the "Upload Tab" in the link dialog. It can point to the default file uploader: <pre>FCKConfig.LinkUploadURL = FCKCon...

== LinkUploadURL ==

This option defines the URL to post files through the "Upload Tab" in the link dialog. It can point to the default file uploader:
<pre>FCKConfig.LinkUploadURL = FCKConfig.BasePath + 'filemanager/connectors/' + _QuickUploadLanguage + '/upload.' + _QuickUploadExtension ;
</pre>
or any custom implementation of it:
<pre>FCKConfig.LinkUploadURL = '/myuploader/upload.php';
</pre>

FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkBrowserURL

2008-01-23T09:15:36Z

W.olchawa:

== LinkBrowserURL ==

Defines the URL to load when clicking the "Browse Server" button in the link dialog. It can point to the default File Browser:
<pre>FCKConfig.LinkBrowserURL = FCKConfig.BasePath
+ 'filemanager/browser/default/browser.html?Connector=../../connectors/' + _FileBrowserLanguage + '/connector.' + _FileBrowserExtension ;
</pre>
or for any custom implementation:
<pre>FCKConfig.LinkBrowserURL = '/myfilebrowserpath/browser.php' ;
</pre>

FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageBrowserURL

2008-01-23T09:14:49Z

W.olchawa:

== ImageBrowserURL ==

Defines the URL to load when clicking the "Browse Server" button in the image dialog. It can point to the default File Browser
<pre>FCKConfig.ImageBrowserURL = FCKConfig.BasePath
+'filemanager/browser/default/browser.html?Connector=../../connectors/' + _FileBrowserLanguage + '/connector.' + _FileBrowserExtension ;
</pre>
or for any custom implementation:
<pre>FCKConfig.ImageBrowserURL = '/myfilebrowserpath/browser.php' ;
</pre>

FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashBrowserURL

2008-01-23T09:14:24Z

W.olchawa: New page: == FlashBrowserURL == Defines the URL to load when clicking the "Browse Server" button in the flash dialog. It can point to the default File Browser: <pre>FCKConfig.FlashBrowserURL = FCKC...

== FlashBrowserURL ==

Defines the URL to load when clicking the "Browse Server" button in the flash dialog. It can point to the default File Browser:
<pre>FCKConfig.FlashBrowserURL = FCKConfig.BasePath
+ 'filemanager/browser/default/browser.html?Connector=../../connectors/' + _FileBrowserLanguage + '/connector.' + _FileBrowserExtension ;
</pre>
or for any custom implementation:
<pre>FCKConfig.FlashBrowserURL = '/myfilebrowserpath/browser.php' ;
</pre>

FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkBrowserURL

2008-01-23T09:13:11Z

W.olchawa:

== LinkBrowserURL ==

Defines the URL to load when clicking the "Browse Server" button in the link dialog. It can point to the default File Browser"
<pre>FCKConfig.LinkBrowserURL = FCKConfig.BasePath
+ 'filemanager/browser/default/browser.html?Connector=../../connectors/' + _FileBrowserLanguage + '/connector.' + _FileBrowserExtension ;
</pre>
or for any custom implementation:
<pre>FCKConfig.LinkBrowserURL = '/myfilebrowserpath/browser.php' ;
</pre>

FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageBrowserURL

2008-01-23T09:12:29Z

W.olchawa:

== ImageBrowserURL ==

Defines the URL to load when clicking the "Browse Server" button in the image dialog. It can point to the default File Browser"
<pre>FCKConfig.ImageBrowserURL = FCKConfig.BasePath
+'filemanager/browser/default/browser.html?Connector=../../connectors/' + _FileBrowserLanguage + '/connector.' + _FileBrowserExtension ;
</pre>
or for any custom implementation:
<pre>FCKConfig.ImageBrowserURL = '/myfilebrowserpath/browser.php' ;
</pre>