source: Dev/branches/rest-dojo-ui/client/dojox/editor/README @ 256

Last change on this file since 256 was 256, checked in by hendrikvanantwerpen, 13 years ago

Reworked project structure based on REST interaction and Dojo library. As
soon as this is stable, the old jQueryUI branch can be removed (it's
kept for reference).
File size: 15.3 KB
Line 
1-------------------------------------------------------------------------------
2dojox.editor
3-------------------------------------------------------------------------------
4Version 0.9
5Release date: 9/14/2009
6-------------------------------------------------------------------------------
7Project state:
8experimental, beta, stable
9-------------------------------------------------------------------------------
10Credits
11        Mike Wilcox      - Author
12        Jared Jurkiewicz - Author (PrettyPrint, PageBreak, ShowBlockNodes,
13                Preview, Save, ToolbarLineBreak, InsertEntity,
14                NormalizeIndentOutdent, Breadcrumb, FindReplace,
15                CollapsibleToolbar, Blockquote, PasteFromWord, InsertAnchor,
16                TextColor, NormalizeStyle, StatusBar, SafePaste)
17        Dustin Machi     - Technical Assistance
18        David Schwartz and Gu Yi He (IBM) - Contributed enhancements to the
19                look and feel of FindReplace, as well as behavioral
20                improvements.
21        Eldon (IBM, CCLA) - LocalImage, AutoUrlLink, TablePluginsColorCell -
22                dojox.widget.ColorPicker, ResizeTableColumn, AutoSave, SpellCheck
23
24-------------------------------------------------------------------------------
25Project description
26
27Space for extensions and additional plugins for dijit.Editor.  The project
28currently contains the following plugins:
29
30dojox.editor.plugins.TablePlugins:
31        Status: Experimental.
32        The Table Plugins provide a mechanism for editing tables withing the
33        dijit.Editor.  This plugin is experimental and does not work correctly
34        in all dojo supported browsers.
35
36dojox.editor.plugins.UploadImage:
37        Status: Experimental.
38        The UploadImage plugin makes use of the dojox upload widgets to provide
39        a mechanism to upload images to your server for use in the editor.
40
41dojox.editor.plugins.PrettyPrint:
42        Status: Supported (stable).
43        The PrettyPrint plugin provides a mechanism by which the output from
44        editor.getValue()/editor.attr("value") is nicely formatted.  Optional
45        format parameters are how many spaces to indent by (default is tab),
46        the maximum text line length (not including indent), and what
47        characters in text strings should be encoded to their &<enc>;
48        representation.
49
50dojox.editor.plugins.PageBreak:
51        Status: Supported (stable).
52        A simple plugin that allows you to insert 'page breaks' into the doc
53        being edited.  These page break styles will then cause the document
54        to break to another page when printed.
55
56dojox.editor.plugins.ShowBlockNodes:
57        Status: Supported (stable).
58        A simple plugin that allows you to toggle on and off a CSS 'view' of
59        how the page is laid out in terms of the block nodes used for its
60        formatting.
61
62dojox.editor.plugins.Save:
63        Status: Supported (beta).
64        A simple plugin that allows you to POST the content of the editor back
65        to a URL.
66
67dojox.editor.plugins.Preview:
68        Status: Supported (beta).
69        A simple plugin that allows you to display the content of the editor
70        in a new window and apply a set of styles to it so you can see how
71        content will look with various styles applied.  It is likely this
72        plugin will still evolve a bit.
73
74dojox.editor.plugins.ToolbarLineBreak:
75        Status: Supported (stable).
76        An extremely simple plugin that allows you to 'linebreak' the dijit toolbar so that really long
77        toolbars for editor (lots of plugins enabled), can be broken up into multiple rows.
78
79dojox.editor.plugins.InsertEntity:
80        Status: Experimental (unsupported).
81        A plugin that enables the ability to insert HTML/XML entity characters
82        into a page.  These are often called 'symbols'.  The set it provides are the
83        basic latin (8859) set and a portion of greek symbols common to mathematics.
84        It has been marked experimental as it is likely this plugin will evolve a bit.
85
86dojox.editor.plugins.NormalizeIndentOutdent:
87        Status: Experimental (unsupported).
88        A plugin that normalizes the behavior of indent/outdent to use margin styles instead
89        of <blockquote> tags.  Also fixes indent/outdent of lists to work properly.  This is new
90        and has been tested, but not extensively.  Therefore it is currently classed as experimental.
91
92dojox.editor.plugins.Breadcrumb:
93        Status: Experimental (unsupported).
94        A plugin that adds a breadcrumb toolbar to the bottom of the editor.  Useful for seeing
95        where you aren and what operations you can perform.  This is new and has been tested, but not
96        extensively.  Therefore it is currently classed as experimental.
97
98dojox.editor.plugins.FindReplace:
99        Status: Experimental (unsupported).
100        A plugin that adds a togglable Find/Replace toolbar to the editor.  Useful for searching
101        and replacing text strings in the editor content.  Only works on FF, IE, and WebKit.  No Opera
102        support.  This is new and has been tested, but not extensively.  Therefore it is currently
103        classed as experimental.
104
105dojox.editor.plugins.CollapsibleToolbar:
106        Status: Supported (Stable).
107        A plugin that modified the header node of the editor so that it is 'collapsible'.  Meaning that
108        it can be closed (reduced), and reopened.  Useful for increasing editor real-estate.
109
110dojox.editor.plugins.Blockquote:
111        Status: Supported (Stable).
112        A plugin that puts a button on the toolbar that allows users to select text for a semantic
113        'blockquote' tag-wrap action.  It toggles on and off during state changes to determine if
114        the current section is contained within a blockquote.
115
116dojox.editor.plugins.PasteFromWord:
117        Status: Beta (unsupported).
118        A plugin that puts a button that opens a dialog to paste in content from Word and similar
119        programs like wordpad.  It will then filter out extraneous and bad html from the content
120        before injecting it into the RTE.   Experimental as the filter list may not be complete yet.
121        Feedback is welcome and appreciated.  Filters will be updated based on it.
122
123dojox.editor.plugins.InsertAnchor:
124        Status: Stable (supported).
125        A plugin that allows anchor points to be inserted into the document being edited.
126        The anchors are styled in the doc to make them easily visible/editable in the document.
127
128dojox.editor.plugins.TextColor:
129        Status: Experimental (unsupported).
130        A plugin that makes use of the dojox.widget.ColorPicker widget in lieu of the
131        dijit.ColorPalette. 
132
133dojox.editor.plugins.NormalizeStyle:
134        Status: Experimental (unsupported).
135        A plugin that tries to normalize the output from the editor as either CSS styled or semantic (<b>, <i>, etc)
136        style.
137
138dojox.editor.plugins.StatusBar:
139        Status: Experimental (unsupported).
140        A plugin that adds a status bar and an optional resize handle to the footer of the editor.
141
142dojox.editor.plugins.LocalImage
143        Status: Beta
144        A plugin that adds local image upload and edit capability to the editor.
145
146dojox.editor.plugins.AutoUrlLink
147        Status: Experimental (Unsupported)
148        A plugin that adds auto url link creation capability as a headless plugin to the editor
149
150dojox.editor.plugins.ResizeColumnPlugin
151        Status: Experimental (Unsupported)
152        A plugin that adds column resize to the editor table plugins.
153
154dojox.editor.plugins.AutoSave
155        Status: Experimental (Unsupported)
156        A plugin that provides 'auto-save' capablity, eg, post back to some url at an interval.
157
158dojox.editor.plugins.SpellCheck
159        Status: Experimental (Unsupported)
160        A plugin that provides server-side spell-check support.
161
162       
163dojox.editor.plugins.SafePaste
164        Status: Beta (Supported)
165        A plugin that provides a safer paste function to the editor.  It strips out script tags,
166        tries to fix up odd input from Word, Wordpad, etc.  Very similar to PasteFromWord except that
167        it takes complete control of paste in dijit.Editor instead of being an alternate paste icon.
168       
169-------------------------------------------------------------------------------
170Dependencies:
171
172dijit
173dojox.form
174dojox.html.format
175dojox.widget.ColorPicker
176dojox.layout.ResizeHandle
177
178-------------------------------------------------------------------------------
179Documentation
180
181The plugins directory contains extensions which work with dijit.Editor.
182
183See also:
184        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/TablePlugins.html
185        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/PrettyPrint.html
186        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/PageBreak.html
187        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/ShowBlockNodes.html
188        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/Preview.html
189        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/Save.html
190        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/ToolbarLineBreak.html
191        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/InsertEntity.html
192        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/NormalizeIndentOutdent.html
193        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/Breadcrumb.html
194        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/FindReplace.html
195        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/CollapsibleToolbar.html
196        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/Blockquote.html
197        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/PasteFromWord.html
198        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/InsertAnchor.html
199        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/TextColor.html
200        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/NormalizeStyle.html
201        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/StatusBar.html
202        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/LocalImage.html
203        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/AutoUrlLink.html
204        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/ResizeTableColumn.html
205        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/AutoSave.html
206        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/SpellCheck.html
207        http://dojotoolkit.org/reference-guide/dojox/editor/plugins/SafePaste.html
208.html
209       
210-------------------------------------------------------------------------------
211Plugin Installation instructions
212
213Get dojo and dijit from svn. Include the Editor and plugins in your page:
214
215dojo.require("dijit.Editor");
216
217For the TablePlugins:
218        dojo.require("dojox.editor.plugins.TablePlugins");
219        and CSS:
220        <link href="[path]dojox/editor/plugins/resources/editorPlugins.css" type="text/css" rel="stylesheet" />
221
222For the UploadImage plugin:
223        dojo.require("dojox.editor.plugins.UploadImage");
224        and CSS:
225        <link href="[path]dojox/editor/plugins/resources/editorPlugins.css" type="text/css" rel="stylesheet" />
226        <link href="[path]dojox/form/resources/FileInput.css" type="text/css" rel="stylesheet" />
227
228For the PrettyPrint plugin:
229        dojo.require("dojox.editor.plugins.PrettyPrint");
230        and CSS:
231        No CSS required.
232
233For the PageBreak plugin:
234        dojo.require("dojox.editor.plugins.PageBreak");
235        and CSS:
236        <link href="[path]dojox/editor/plugins/resources/css/PageBreak.css" type="text/css" rel="stylesheet" />
237
238For the ShowBlockNodes plugin:
239        dojo.require("dojox.editor.plugins.ShowBockNodes");
240        and CSS:
241        <link href="[path]dojox/editor/plugins/resources/css/ShowBlockNodes.css" type="text/css" rel="stylesheet" />
242
243For the Preview plugin:
244        dojo.require("dojox.editor.plugins.Preview");
245        and CSS:
246        <link href="[path]dojox/editor/plugins/resources/css/Preview.css" type="text/css" rel="stylesheet" />
247
248For the Save plugin:
249        dojo.require("dojox.editor.plugins.Save");
250        and CSS:
251        <link href="[path]dojox/editor/plugins/resources/css/Save.css" type="text/css" rel="stylesheet" />
252
253For the ToolbarLineBreak plugin:
254        dojo.require("dojox.editor.plugins.ToolbarLineBreak");
255        and CSS:
256        No CSS required.
257
258For the InsertEntity plugin:
259        dojo.require("dojox.editor.plugins.InsertEntity");
260        and CSS:
261        <link href="[path]dojox/editor/plugins/resources/css/InsertEntity.css" type="text/css" rel="stylesheet" />
262
263For the NormalizeIndentOutdent plugin:
264        dojo.require("dojox.editor.plugins.NormalizeIndentOutdent");
265        and CSS:
266        No CSS required.
267
268For the Breadcrumb plugin:
269        dojo.require("dojox.editor.plugins.Breadcrumb");
270        and CSS:
271        <link href="[path]dojox/editor/plugins/resources/css/Breadcrumb.css" type="text/css" rel="stylesheet" />
272
273For the FindReplace plugin:
274        dojo.require("dojox.editor.plugins.FindReplace");
275        and CSS:
276        <link href="[path]dojox/editor/plugins/resources/css/FindReplace.css" type="text/css" rel="stylesheet" />
277
278For the CollapsibleToolbar plugin:
279        dojo.require("dojox.editor.plugins.CollapsibleToolbar");
280        and CSS:
281        <link href="[path]dojox/editor/plugins/resources/css/CollapsibleToolbar.css" type="text/css" rel="stylesheet" />
282
283For the Blockquote plugin:
284        dojo.require("dojox.editor.plugins.Blockquote");
285        and CSS:
286        <link href="[path]dojox/editor/plugins/resources/css/Blockquote.css" type="text/css" rel="stylesheet" />
287
288For the PasteFromWord plugin:
289        dojo.require("dojox.editor.plugins.PasteFromWord");
290        and CSS:
291        <link href="[path]dojox/editor/plugins/resources/css/PasteFromWord.css" type="text/css" rel="stylesheet" />
292
293For the InsertAnchor plugin:
294        dojo.require("dojox.editor.plugins.InsertAnchor");
295        and CSS:
296        <link href="[path]dojox/editor/plugins/resources/css/InsertAnchor.css" type="text/css" rel="stylesheet" />
297
298For the TextColor plugin:
299        dojo.require("dojox.editor.plugins.TextColor");
300        and CSS:
301        <link href="[path]dojox/editor/plugins/resources/css/TextColor.css" type="text/css" rel="stylesheet" />
302
303For the NormalizeStyle plugin:
304        dojo.require("dojox.editor.plugins.NormalizeStyle");
305        and CSS:
306        No CSS required.
307
308For the StatusBar plugin:
309        dojo.require("dojox.editor.plugins.StatusBar");
310        and CSS:
311        <link href="[path]dojox/editor/plugins/resources/css/StatusBar.css" type="text/css" rel="stylesheet" />
312
313For the LocalImage plugin:
314        dojo.require("dojox.editor.plugins.LocalImage");
315        and CSS:
316        <link href="[path]dojox/editor/plugins/resources/css/LocalImage.css" type="text/css" rel="stylesheet" />
317
318For the AutoUrlLink plugin:
319        dojo.require("dojox.editor.plugins.AutoUrlLink");
320        and CSS:
321        No CSS required.
322
323For the ResizeTableColumn plugin:
324        dojo.require("dojox.editor.plugins.ResizeTableColumn");
325        and CSS:
326        No CSS required in addition to the table plugins css.
327
328For the AutoSave plugin:
329        dojo.require("dojox.editor.plugins.AutoSave");
330        and CSS:
331        <link href="[path]dojox/editor/plugins/resources/css/AutoSave.css" type="text/css" rel="stylesheet" />
332       
333For the SpellCheck plugin:
334        dojo.require("dojox.editor.plugins.SpellCheck");
335        and CSS:
336        <link href="[path]dojox/editor/plugins/resources/css/SpellCheck.css" type="text/css" rel="stylesheet" />
337
338For the SafePaste plugin:
339        dojo.require("dojox.editor.plugins.SafePaste");
340        and CSS:
341        <link href="[path]dojox/editor/plugins/resources/css/SafePaste.css" type="text/css" rel="stylesheet" />
342       
343See tests for examples:
344        dojox/editor/tests/editorTablePlugs.html
345        dojox/editor/tests/editorUploadPlug.html
346        dojox/editor/tests/editorPrettyPrint.html
347        dojox/editor/tests/editorPageBreak.html
348        dojox/editor/tests/editorShowBlockNodes.html
349        dojox/editor/tests/editorPreview.html
350        dojox/editor/tests/editorSave.html
351        dojox/editor/tests/editorToolbarLineBreak.html
352        dojox/editor/tests/editorInsertEntity.html
353        dojox/editor/tests/editorNormalizeIndentOutdent.html
354        dojox/editor/tests/editorBreadcrumb.html
355        dojox/editor/tests/editorFindReplace.html
356        dojox/editor/tests/editorCollapsibleToolbar.html
357        dojox/editor/tests/editorBlockquote.html
358        dojox/editor/tests/editorPasteFromWord.html
359        dojox/editor/tests/editorInsertAnchor.html
360        dojox/editor/tests/editorTextColor.html
361        dojox/editor/tests/editorNormalizeStyle.html
362        dojox/editor/tests/editorStatusBar.html
363        dojox/editor/tests/editorLocalImage.html
364        dojox/editor/tests/editorAutoUrlLink.html
365        dojox/editor/tests/editorResizeTableColumn.html
366        dojox/editor/tests/editorAutoSave.html
367        dojox/editor/tests/editorSpellCheck.html
368        dojox/editor/tests/editorSafePaste.html
369        dojox/editor/tests/testPluginsAll.html
Note: See TracBrowser for help on using the repository browser.