Products.FCKeditor 2.6.1

========
README :
========


-----------------------------------------------------------------------------------
Introduction
-----------------------------------------------------------------------------------

This product is a FCKEditor Plone integration.
This work is not a Kupu competitor, on the contrary it could not live without Kupu
and it takes many features from Kupu.
Talking about Kupu vs FCKeditor is a sterile discussion, use it only if you need
it, in some situations it could be a precious partner, in other cases it could be
unnecessary.

The new default configuration is 100% Plone aware, since text fonts, forms and
colors menus has been removed (you can always add it through configlet and toolbar
customization at your own risk). A better solution is to improve the templates
menu and the styles menu configurations through configlet or widget.

Speaking of widget, since FCKeditor 2.4.3 a specific widget has been added in
FCK.Plone product for developpers who want different fckeditor configurations for
different fields in their own AT content types.

For more information read documentation inside product :
- "docs" folder contains all documentation
- "_whatsnew.html", "_documentation.html" and "_upgrade.html" contain informations
about the original FCKEditor product.


------------------------------------------------------------------------------------
FCKeditor.Plone 2.6.1 - Plone product installation
------------------------------------------------------------------------------------


FCKeditor.Plone 2.6.1 is based on FCKeditor 2.6 original code source.
This package is Plone 3.xx and Plone 2.5.x compatible (Plone 2.0x is no more supported,
this last release was not tested with Plone 2.1.x)
Since 2.4.3, Plone3 kss rich content edition is fully supported.

Read docs/INSTALL.txt

Go to your Plone Site > Plone Control Panel > Add Remove Products,
Choose FCKeditor ...
or use Portal_QuickInstaller inside ZMI.

Then read docs/FAQ.txt

Upgrade :
read the upgrade help in docs/FAQ.txt

download + install from SVN:
read docs/SVN.txt (important)



--------------------------------------------------------------------------------------
Support
--------------------------------------------------------------------------------------
support@ingeniweb.com

Plone project page (infos, tracker, download ...) :
http://plone.org/products/fckeditor

Issues Tracker :
http://trac.ingeniweb.com


For more information about original editor:

FCK Editor web site : http://fckeditor.net/
FCK Editor dev trac : http://dev.fckeditor.net/


-------------------------------------------------------------------------------------
Copyright
-------------------------------------------------------------------------------------
FCKeditor - The text editor for internet
Version 2.6
Copyright (C) 2003-2007 Frederico Caldeira Knabben
Authors:
Frederico Caldeira Knabben (fredck@fckeditor.net)
see license.txt



FCKeditor.Plone :
Licensed under the terms of the following license :

- GNU General Public License Version 2 or later (the "GPL")
http://www.gnu.org/licenses/gpl.html
(See Appendix A)

Since June 2006 : (c) Ingeniweb SARL - support@ingeniweb.com
Maintainers : Jean-mat Grimaldi, Gilles Lenfant, Youenn Boussard
Thx to:
Frederico and the FCKeditor community
Ingeniweb boys and girls
... see old releases for all many thx


======================
FCKEditor Plone Help :
======================

---------------------------------
I. FCKeditor.Plone upgrade
---------------------------------

- Uninstall FCK editor from your Plone site (Quick Installer or Plone Control Panel)
- Delete FCKeditor directory from your_instance/Products directory if exists (for versions < 2.6)
- Read INSTALL.txt for buildout installation or how to use easy_install
- Restart Zope
- Install FCKeditor.Plone in your Plone Site via QuickInstaller or Plone Control Panel
- Configure FCKeditor through the Plone control panel.


FCK_PROPERTIES :
================

When upgrading from FCKeditor.Plone >= 2.2.x fckeditor plone properties are
preserved after install/uninstall but if you want you can clean it (recommanded) :
ZMI > your site > portal_properties - delete fckeditor_properties
Since FCKEditor.Plone 2.3.2 spellCheck properties have changed, if you have customized your toolbar,
change "SpellCheck" in "rtSpellCheck" for ff2+ and MSIE6+ client spellchecker. If you were using
aspell server spellchecker, it's not required.
Since FCKEditor.Plone 2.3.3 "FitWindow" button has been added to switch editor field in fullscreen
mode, if you have customized your toolbar, add 'FitWindow' in your customized toolbar.
Since FCKEditor.Plone 2.4.1 "UniversalKey" function has been removed,
if you have customized your toolbar, remove 'UniversalKey' from your customized toolbar.
Since FCKEditor.Plone 2.4.3 "UniversalKey" function has been re-added as optional plugin,
you can add 'UniversalKey' in your customized toolbar.
Since FCKEditor.Plone 2.4.3 new important properties have been added, so deleting fckeditor_properties
is highly recommanded (just rename it and you would be able to copy/paste by hand some of your customized properties)
Since FCKEditor.Plone 2.6 one property have been removed : "gecko_uses_span" (no more useful because IE doesn't use Font tag anymore)

CACHE :
=======

For better performance All FCKeditor js, css files and images are loaded from
client http cache or proxy caches but :

>> If you don't clear the caches many js errors could happen after upgrade ! <<

- Give your site users advice of upgrade and tell them to clear their browser cache
- purge your reverseproxy cache folder if necessary



Upgrade from old FCK.Plone versions (<=2.2) :
=============================================

- Delete all previous specific FCKeditor ZMI customizations,

- You could need to upgrade your members wysiwyg_editor property
in your portal_membership (this property has changed since FCKeditor.Plone 2.0.1 for easy cohabitation with Kupu and Epoz),
follow these steps :

* In your Plone site ZMI > create an External Method
Id : updateFckUsers
Title : updateFckUsers
Module Name : FCKeditor.updateFckUsers
Function Name : updateFckUsers

* Click on test

* Your portal_membership is updated



-----------------------------------
II. FCKeditor.Plone Update from svn
-----------------------------------

If you have downloaded FCKeditor.Plone from Plone collective SVN, launch utils/base2zope.py
at python prompt, before installation, it's a mandatory.


----------
III. FAQ
----------

1. How to enable flash publication with Plone ?
ZMI > your Plone Site > portal_transforms > safe_html
Add "embed" tag (value=1) in valid_tags
Remove "embed" tag from nasty_tags
Restart your instance.

2. How to enable font color/size modifications ?
Go to fckeditor controlpanel, choose custom toolbar and choose to enable fonts and colors.
For MSIE :
ZMI > your Plone Site > portal_transforms > safe_html
Add "font" tag (value=1) in valid_tags
Restart your instance.
(font tag is not XHTML compliant and it can be destructive for design, so prefer to
improve the style combo menu option which is more powerful)

3. How to enable javascript events publication (popups, onclick, onmouseover ...) with Plone 2.1 ?
ZMI > your Plone Site > portal_transforms > safe_html
set remove_javascript to 0
This does not effect <script> tags
Restart your instance.
It's not recommanded


4. How to disable file and/or image and/or flash upload ?
Set this option in FCKEditor Plone Control Panel


5. How To change default style in editor windows ?
plone.css & ploneCustom.css (plone 2.0.x)) or portal_css (plone 2.1) are used by default.
You can set your own css with FCKEditor Plone Control Panel

6. How To change toolbars set ?
with FCKEditor Plone Control Panel

7. How To Force Paste as Plain Text when copy-paste from rich-text document ?
choose this option with FCKEditor Plone Control Panel


8. How to disable unique ID referencing when browsing server AT Content Types and Plone 2.1 standard Content types ?
Use the FCKeditor Plone Control Panel


9. How to publish absolute links ?
Nothing to do. In editor and after page saving, all internal links are stored as "unik id" links,
but these links are transformed in absolute urls by Plone portal_transforms when displaying the page for a simple view.


10. How to use your custom styles in the editor area and combo menu ?
In the FCKeditor Plone Control Panel Modify the field "FCK Editor Styles List"
If you want to use classes you need to check up your plone styles

11. How to set FCK Editor as default editor for all new members in your Plone site :
- Go in ZMI > Your Site > portal_member_data > properties
- In the field "wysiwyg_editor" enter "FCKeditor"
- submit the form


12. How to force the Member personal folder as opening folder in browser and for fast upload ?
Choose this option in FCKeditor Plone Control Panel

13. How to force the browser's root to Member personnal folder ?
If you follow the step 9, the user will use his personnal folder for fast upload
and the browser will be open in this folder, but the user is still able to browse
all site published contents.
You can set the browser root if you want :

To force the browser root to Member personal Folder : choose this option in FCKeditor Plone Control Panel

14. How to force browser path or browser root to a particular folder ?
Choose it in the FCKeditor Plone Control Panel

15. How does FireFox 2.0 spellchecker work ?
End User must click on spellchecker icon.
End User must install and choose dictionnary for his language
by right clicking in fckeditor area or another form text area.
When spellcheck icon is enable in FCK bad words are red underlined
Now, user can replace/add to dictionnary .... in editor area.
FireFox spellchecker is really powerful feature, advise authors to use FireFox ;-)

16. How to change portal_types used for file/image/flash upload ?
Choose it in the FCKeditor Plone Control Panel

17. How To make FCKeditor able to browse inside my specific PloneArticle based types ?
Choose your Plone Article meta_types in FCKEditor Control Panel.

18. How To change the portal_types used by PloneArticle attachements and images ?
Choose it in Plone Article Control Panel (not in FCKEditor CP)

19. Why did you get many errors after upgrading FCKeditor.Plone
(content disappearing, js errors, editor disappearing ...)?
>> Read carefully §I <<

20. How to get different FCKeditor configurations for different fields in my own AT Content Types ?
Use FCKWidget for your fields (see RichContentDemo.py for an example)

21. How to make FCKeditor.Plone working without kss :
just add fck_ploneInit.js in portal_javascripts with standard options

-----------------------
IV. SUPPORT OPEN SOURCE
-----------------------

You want the last fckeditor version for Plone ?
You need new features ?
You need more support ?

It's easy, send an email to support@ingeniweb.com, we will explain you how to support our work and
how we could maintain this product together.

-----------
V. CONTACTS
-----------

support@ingeniweb.com for Plone Product

http://fckeditor.net/ for the fckeditor source


======
TODO :
======

--------------------
Roadmap - 2008/06/13
--------------------

- make a new package plone.fckeditor

- Generic Setup Plone installer

deadline : August 2008

- Replace python scripts (really messed up) by clean Five views.

deadline : August 2008

- Import the original fckeditor code (html + js) as a browser folder resource,
no more as a CMF skin layout.

deadline : August 2008


-------------------------
Good intents - 2008/06/13
-------------------------

- more documentation and screencasts for end users

- A more functional "plone explorer" (ajax browser to edit/remove/publish ....), which can be used
as a separate widget for fast attachments upload, fast linking, ... A separate
product will be the good way.

- A python server-side spellchecker script to make fckeditor spellchecker pages
more easy to use with Plone.
This feature is easy to implement, but it's no more a priority because
client side spellcheckers are more practical, and FCKEditor.Plone always
provides FireFox and MSIE spellcheckers integration.


All contributions are welcome.


==============
LAST CHANGES :
==============

------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Changes in FCK.Plone 2.6.1 :
------------------------------------------------------------------------------------------------------------------------------------------------------------------------

1. Images explorer : same behavior for all browsers (nb of images by row in album view depends on browser innerWidth)

2. Images explorer : same behavior for PloneArticleV4 Images and standard Plone images (same sizes)

3. fix bug http://trac.ingeniweb.com/ticket/65 (flash insertion was broken)

4. setup.py changed (name was bad)

------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Changes in FCK.Plone 2.6 :
------------------------------------------------------------------------------------------------------------------------------------------------------------------------

1. Trunk moved to Products.FCKeditor/trunk to make an FCKeditor.Plone basic egg
http://trac.ingeniweb.com/ticket/55 in progress ...

2. FCKEditor 2.6 integration :
close ticket : http://trac.ingeniweb.com/ticket/54