Bumped the version up to 1.9.3
[moodle.git] / lib / yui / editor / README
blob2c67d6748f0cf8fb56dce151c224574f9bae2842
1 **** version 2.6.0 ***
2     
3     * Widget promoted to GA - beta flag removed from all files.
5     * Firefox
6             * 1776202 - FF:rich text formatting (italize) lost when color is selected in RTE
7             * 1886390 - [SF 1946017] Unable to delete text when editor opens (Firefox)
8             * 2030281 - [SF 2002911] Problem with Header styling in Firefox
9         * 1765001 - [SF 1899196] Firefox button Inconsistencies
11     * Internet Explorer
12             * 1842631 - [SF 1869619] Image Modification Dialog
13             * 2006122 - [SF 1995892] set('disabled',false) cause IE6 error 
14             * 2092598 - [SF 2021359] IE7: dbl click image doesn't show settings dialog
15             * 2093275 - [SF 2026296] Auto Adjusting height bug in IE
16             * 2093325 - [SF 2025092] IE7:allowNoEdit turned on period '.' doesn't work
17             * 2099035 - [SF 2027048] keyDown event does not fire in IE after enabling editor
18             * 2189912 - [SF 2093253] Editor used in HTTPS page will provoke Security warning
19         * 1655240 - [SF 1851177] Text Align not working correctly in IE
20             * 1984727 - [SF 1986820] Clicking bulleted list before typing creates empty <li> IE7
21             * 2108127 - [SF 2027073] IE7: editor list items misaligned 
22             * 1918222 - [SF 1956586] Fontsize is not updating when nodechange in IE
24     * Safari
25             * 1972354 - [SF 1978372] Safari/IE list creation quirk
26             * 1972367 - [SF 1978350] Safari 3.1 issue with lists
28     * All
29         * 1508375 - [SF 1791252, 1964709] Have Undo, Redo functions in Editor  
30             * 1839296 - [SF 1926238] Editor adds extra </li> tag at the end of a list
31             * 1844215 - [SF 1928426] filter_invalid_lists
32             * 1844258 - [SF 1923255] Give descriptive error when container isn't textarea
33             * 1851344 - [SF 1931768] Relative links automatically converted to absolute links.
34             * 1870106 - Add a strikethrough/blockquote buttons for the Rich Text Editor
35             * 1886339 - [SF 1946874] Double clicking in the editor sets "editorDirty" false
36             * 1892984 - [SF 1919826] Regex matches both <b> and <button>
37             * 1901545 - Rich Text Editor - Link menu's url encoding "&" to "&amp"       
38             * 1908178 - [SF 1954228] Deleting 1+ button from buttonType:advanced fails
39             * 1926462 - html encoded characters are unencoded
40             * 1964404 - [SF 1975463] Editor.destroy() doesn't destroy editor windows
41             * 1984734 - [SF 1986184] error on _formButtonClicked log message
42             * 2030229 - [SF 2003080] Various widths affect toolbar layout
43             * 2138168 - [SF 2048035] autoHeight will cause dialog panels to be misaligned
44             * 2166952 - [SF 2065060] Tab & shift-tab should move focus from the editor
45             * 2178829 - [SF 2077747] Simple editor losing its format when font color changes
46         * 2015947 - [SF 1998524] Alignment Code doesn't generate
47         * 2118761 - [SF 2035187] Custom Editor body CSS only applies to visited links
48         * 2118723 - [SF 2034544] Image Options Dialog Box needs fixing
49         * 2036613 - [SF 2007145] Removing underline not working in IE6/7, FF3
50         * 2065013 - [SF 2015601] Text in some controls is not vertically centered
51             * 1918278 - [SF 1955931] font color (background color) doesn't work properly
52             * 1972427 - [SF 1954095] Bulleting
53         * 1839224 - [SF 1925337] editor indent/outdent inconsistent behavior
54             * 2006092 - [SF 1996074] Indent changes the font to Arial
55         * 206493 - Handle Submit Failing
58 **** version 2.5.2 ***
59     * Firefox 3
60         * 1898002 - Fixed tabbing issues
62     * Internet Explorer
63         * 1898002 - Fixed tabbing issues
64         * 1824259 - [SF 1918308] Rich Text Editor: colouring a word colours the sentence
66     * All
67         * 1847813 - [SF 1930871] RTE doesn't load if handleSubmit: false explicitly defined
68         * 1841312 - In the RTE image menu the label for "link Url" and "image URL" aren't the same
69         * Color picker stays active when loses focus (Basic Buttons)
70         * Fixed CSS for toolbar seperators to allow for the groups to float better.
72 **** version 2.5.1 ***
74     * Adobe AIR Support
75         * 1763867 - Adobe AIR: iFrame document open
76         * 1763869 - Adobe AIR: Blank Image insertion fails
77         * 1763872 - Adobe AIR: Setting font-family fails
78         * 1763880 - Adobe AIR: Image Editor should show copy/paste note
80     * Internet Explorer
81         * 1556954 - [SF 1816784 ] tabbing troubles...
82         * 1776579 - [SF 1873881 ] IE Bulleting Behavior
84     * Safari
85         * 1775802 - [SF 1899803] Links in safari are treated as regular links...
86         * 1777918 - [SF 1898878 ] Safari uses <span> instead of <strong> tags...
88     * All
89         * 1776107 - ToolbarButton doesn't have a destroy method
90         * 1776117 - Editor Accessibility Enhancements
91         * 1776539 - [SF 1874009 ] Greedy Regex in RTE Eats embed and other tags
92         * 1777925 - [SF 1878976 ] Regex matches both <i> and <iframe>
93         * 1764038 - [SF 1898886 ] Problem with handleSubmit after move to 2.5.0
94         * 1693686 - [SF 1869619] Image Modification Dialog
97 **** version 2.5.0 ***
99     *Examples:
100         1. [1687273] - [SF 1861119 ] Flickr Example code is incorrect
102     *Config
103         1. [1556954] - [SF 1816784 ] tabbing troubles...
104             Added a new config option called plainText. (See API docs for more information)
105         2. Removed the requirement for a textarea. If you pass the config as the first argument to the constructor
106             the Editor will create the textarea for you.
108     *Internet Explorer
109         1. [1515145] - [SF 1807057 ] RTE _setDesignMode reloads page content
110         2. [1687267] - [SF 1861514 ] editorContentLoaded fires early in IE6/7
111         3. [1687244] - [SF 1866217 ] Editor in frameset causes "unspecified error" in IE6
112         4. [1687278] - [SF 1859031 ] Change Font Color on IE
113         5. [1687283] - [SF 1857798 ] IE7 RTE HTTPS problem
114         6. [1687316] - [SF 1854657 ] IE bullet/number strange behaviour
115     
116     *All
117         1. [1687258] - [SF 1862824 ] Problem with <script> tags in editor content
118         2. [1687292] - [SF 1857235 ] cleanHTML function stripping closing tags
119         3. [1687322] - [SF 1849730 ] Multiple Editors' toolbars conflict
120         4. [1688270] - [SF 1867927] Editor dynamic height adjust
121         5. [1693656] - [SF 1870215] handleSubmit hijacks the value of the submit button
122         6. [1693686] - [SF 1869619] Image Modification Dialog
123         7. [1693719] - [SF 1850814] Editor produces faulty code
126 **** version 2.4.0 ***
128 * Performance enhancements and bug fixes.
129 * Created a new base class called SimpleEditor. Editor now extends SimpleEditor
130 * Created 2 new Toolbar Buttons
131     YAHOO.widget.ToolbarButton - No requirement for Button or Menu
132     YAHOO.widget.ToolbarButtonAdvanced - Still Required Button and Menu
134     *All
135         1. [1423860] - [SF 1774823] Change text size removes selection highlight
136         2. [1487601] - [SF 1796897] Font size issue
137         3. [1508412] - [SF 1799379] setEditorHTML strips title attribute
138         4. [1528759] - [SF 1810162] [example] Link Options Window appears behind the editor
139             Added a config option "limitCommands" when set to true, the editor will not execute a command that is not bound to a button.
141         5. [1544149] - [SF 1808154] add non-editable snippets to YUI-RTE
142             Added a config option "allowNoEdit", when set to true the "_isNonEditalble method is called at the beginning of all event handlers to check if this element or
143                 a parent element has the class yui-noedit (this.CLASS_NOEDIT) applied. If it does, then this method will stop the event and return true. The event handlers
144                 will then return false and stop the nodeChange from occurring. This method will also disable and enable the Editor's toolbar based on the noedit state.
146         6. [1544160] - [SF 1808102] Keep the content of invalidHTML
147             If you set the value of a key in this.invalidHTML to "{ keepContents: true }", then the element will be replaced with a yui-non span to be filtered out when 
148                 cleanHTML is called. The only tag that is ignored here is the span tag as it will force the Editor into a loop and freeze the browser. However, all of
149                 these tags will be removed in the cleanHTML routine
151         7. [1560982] - [SF 1818681] RTE converts input tags to emnput
152         8. [1508390] - [SF 1787357] Split into separate modules
153             Split the Editor into Editor and SimpleEditor. Also split out the execCommand support into several methods for easier overriding and extending.
155         9. [1508403] - [SF 1779516] Dirty flag for editor
156             You can now check the editorDirty property on the Editor instance. It will be default false and be set to true when something important happens.
157             You will need to manually change it back to false when you check it.
159     *Internet Explorer
160         1. [1508413] - [SF 1804028, 1810362] Omission of DocType at top of page
161             It appears that Internet Explorer doesn't like the page containing the Editor to not have a doctype if the page inside the editor does.
162                 The Editor will now check for compatMode and if it is not in standards mode, it will omit the doctype from the editable area.
163                 
164         2. [1528733] - [SF 1808818] IE6 reports security violation on secure pages
165         3. [1528766] - [SF 1810362] Will Not Work Without DTD header
166         4. [1496536] - yui editor indentation problem
167         5. [1465375] - [SF 1789702] RTE Image insertion creates timer error
169     *Firefox
170         1. [1492573] - Can not get focus on edit box in FF 1.5 on FreeBSD
172 **** version 2.3.1 ***
174 * Performance enhancements and bug fixes.
176     *All
177         1. [1406169] - Fixed Toolbar performance issues
178         2. [1406176] - You can now set the height and width of the editor after it has been rendered       
179         3. [1413456] - Group Labels can now be turned off after the editor has been rendered
180         4. [1413750] - Editor now supports delayed render (script block above the textarea markup)
181         5. [1416349] - cleanHTML now supports markup config options better (added xhtml option)
182         6. [1422334] - Added a link field to the image property editor
183         7. [1425540] - [SF 1775187] Fixed adding a link to an LI
184         8. [1406370] - [SF 1767246 ] Using Back button causes breaking behavior. Fixed.
185         9. [1435809] - Base href config fails when on a page with a port number. Fixed.
187     *Safari
188         1. [1390926] - Fixed Safari handleSubmit issue
189         2. [1433563] - Editor becomes unstable when rendered inside an element set to display: none (added show() method)
191     *Opera
192         1. [1396921] - Fixed clicking the Toolbar while typing loses insertion point
193         2. [1406700] - [SF 1767251] Background color can not be overridden in Opera.. Fixed.
195     *Gecko
196         1. [1411911] - [SF 1769657] RTE looks strange on Firefox when base.css - Fixed style collisions
197         2. [1433563] - Editor becomes unstable when rendered inside an element set to display: none (added show() method)
199     *Internet Explorer
200         1. [1396921] - Fixed clicking the Toolbar while typing loses insertion point
203 **** version 2.3.0 ***
205 * Beta release.
207 * Known Issues
208     * All
209         1. Removed the menu for Create Ordered Lists, it now defaults to creating a simple OL with no type.
210      
211     * Safari
212         1. Bug #1390926 - Safari may not inject the editor's HTML into the text area when the config handleSubmit is set to true.
213             You can get around this with the following code (where comment is the id of the textarea):
214                 YAHOO.util.Dom.setStyle('comment', 'visibility', 'hidden');
215                 YAHOO.util.Dom.setStyle('comment', 'position', 'absolute');
216                 YAHOO.util.Dom.setStyle('comment', 'display', 'block');
217                 oEditor.saveHTML();
218                 window.setTimeout(function() {
219                         YAHOO.util.Dom.get('comment').form.submit();
220                 }, 200);
222             This issue will be fixed in a later release..
223         2. Unable to get the cursor position inside the editable area.
224             What this means is that when an image/object is inserted into the document
225             we have no way of knowing "exactly" where to put it. So we make an educated guess.
226             If they user clicked on an "element" (HTML Element) in the editor, then we will place
227             the newly inserted element directly after it in the DOM. If there was no element clicked
228             We will append the new element to the body.
230         3. Ordered/Unorder Lists are not support natively. So we have built a work around for this.
231             Most browsers will allow you to select a block of text and create a list out of it "automagically"
232             by inserting an LI around blocks that are separated by line breaks, BRs or Ps. In Safari, the 
233             entire text block will be turned into the first LI of the list. The user can then place the cursor
234             at the beginning of each line, and backspace, then hit enter to create the new list item. There are some
235             use cases that this might fail.
237         4. Dragging and dropping of selections and images/objects is not supported.
238             Safari will do some weird things if the text in the editable area is selected and dragged and dropped.
239             We prevent this from happening to images inside of the editable area, but we can not prevent it for text.
240             Safari will also give unexpected results if text from another Safari window in selected, then dragged
241             into the editable area.
243     * Opera
244         1. Placing the cursor in the editor, then Shift Clicking to highlight will not work. The limitation appear to be in Opera.
246         2. Image resize is unavailable, due to limitations in the browser
248         3. Shortcut keys are not supported in this release.
250         4. Dragging and dropping of selections and images/objects is not supported.
252         5. Hitting the back button on the page will not reload the iframe.
254         6. Selecting the editable area, then hitting the shortcut keys for "Reload" will
255             cause the current page to be displayed inside the editable area.
258 **** version 2.3.0 Peview Release Notes ***
260 * The only server side resource required to run the editor, is the blankimage file.
261     The blankimage file is the temporary image loaded into the editor when you click the
262     "Insert Image" button in the toolbar.
264     This can be set using:
266     var myEditor = new YAHOO.widget.Editor('test', {
267         blankimage: 'MY_IMAGE_PATH'
268     });
270 * There is a performance issue with Safari on a G4 computer. We will be working to get this resolved before the initial beta release.