diff options
Diffstat (limited to 'js/dojo/dojox/editor/README')
| -rw-r--r-- | js/dojo/dojox/editor/README | 369 |
1 files changed, 369 insertions, 0 deletions
diff --git a/js/dojo/dojox/editor/README b/js/dojo/dojox/editor/README new file mode 100644 index 0000000..251c9ce --- /dev/null +++ b/js/dojo/dojox/editor/README @@ -0,0 +1,369 @@ +------------------------------------------------------------------------------- +dojox.editor +------------------------------------------------------------------------------- +Version 0.9 +Release date: 9/14/2009 +------------------------------------------------------------------------------- +Project state: +experimental, beta, stable +------------------------------------------------------------------------------- +Credits + Mike Wilcox - Author + Jared Jurkiewicz - Author (PrettyPrint, PageBreak, ShowBlockNodes, + Preview, Save, ToolbarLineBreak, InsertEntity, + NormalizeIndentOutdent, Breadcrumb, FindReplace, + CollapsibleToolbar, Blockquote, PasteFromWord, InsertAnchor, + TextColor, NormalizeStyle, StatusBar, SafePaste) + Dustin Machi - Technical Assistance + David Schwartz and Gu Yi He (IBM) - Contributed enhancements to the + look and feel of FindReplace, as well as behavioral + improvements. + Eldon (IBM, CCLA) - LocalImage, AutoUrlLink, TablePluginsColorCell - + dojox.widget.ColorPicker, ResizeTableColumn, AutoSave, SpellCheck + +------------------------------------------------------------------------------- +Project description + +Space for extensions and additional plugins for dijit.Editor. The project +currently contains the following plugins: + +dojox.editor.plugins.TablePlugins: + Status: Experimental. + The Table Plugins provide a mechanism for editing tables withing the + dijit.Editor. This plugin is experimental and does not work correctly + in all dojo supported browsers. + +dojox.editor.plugins.UploadImage: + Status: Experimental. + The UploadImage plugin makes use of the dojox upload widgets to provide + a mechanism to upload images to your server for use in the editor. + +dojox.editor.plugins.PrettyPrint: + Status: Supported (stable). + The PrettyPrint plugin provides a mechanism by which the output from + editor.getValue()/editor.attr("value") is nicely formatted. Optional + format parameters are how many spaces to indent by (default is tab), + the maximum text line length (not including indent), and what + characters in text strings should be encoded to their &<enc>; + representation. + +dojox.editor.plugins.PageBreak: + Status: Supported (stable). + A simple plugin that allows you to insert 'page breaks' into the doc + being edited. These page break styles will then cause the document + to break to another page when printed. + +dojox.editor.plugins.ShowBlockNodes: + Status: Supported (stable). + A simple plugin that allows you to toggle on and off a CSS 'view' of + how the page is laid out in terms of the block nodes used for its + formatting. + +dojox.editor.plugins.Save: + Status: Supported (beta). + A simple plugin that allows you to POST the content of the editor back + to a URL. + +dojox.editor.plugins.Preview: + Status: Supported (beta). + A simple plugin that allows you to display the content of the editor + in a new window and apply a set of styles to it so you can see how + content will look with various styles applied. It is likely this + plugin will still evolve a bit. + +dojox.editor.plugins.ToolbarLineBreak: + Status: Supported (stable). + An extremely simple plugin that allows you to 'linebreak' the dijit toolbar so that really long + toolbars for editor (lots of plugins enabled), can be broken up into multiple rows. + +dojox.editor.plugins.InsertEntity: + Status: Experimental (unsupported). + A plugin that enables the ability to insert HTML/XML entity characters + into a page. These are often called 'symbols'. The set it provides are the + basic latin (8859) set and a portion of greek symbols common to mathematics. + It has been marked experimental as it is likely this plugin will evolve a bit. + +dojox.editor.plugins.NormalizeIndentOutdent: + Status: Experimental (unsupported). + A plugin that normalizes the behavior of indent/outdent to use margin styles instead + of <blockquote> tags. Also fixes indent/outdent of lists to work properly. This is new + and has been tested, but not extensively. Therefore it is currently classed as experimental. + +dojox.editor.plugins.Breadcrumb: + Status: Experimental (unsupported). + A plugin that adds a breadcrumb toolbar to the bottom of the editor. Useful for seeing + where you aren and what operations you can perform. This is new and has been tested, but not + extensively. Therefore it is currently classed as experimental. + +dojox.editor.plugins.FindReplace: + Status: Experimental (unsupported). + A plugin that adds a togglable Find/Replace toolbar to the editor. Useful for searching + and replacing text strings in the editor content. Only works on FF, IE, and WebKit. No Opera + support. This is new and has been tested, but not extensively. Therefore it is currently + classed as experimental. + +dojox.editor.plugins.CollapsibleToolbar: + Status: Supported (Stable). + A plugin that modified the header node of the editor so that it is 'collapsible'. Meaning that + it can be closed (reduced), and reopened. Useful for increasing editor real-estate. + +dojox.editor.plugins.Blockquote: + Status: Supported (Stable). + A plugin that puts a button on the toolbar that allows users to select text for a semantic + 'blockquote' tag-wrap action. It toggles on and off during state changes to determine if + the current section is contained within a blockquote. + +dojox.editor.plugins.PasteFromWord: + Status: Beta (unsupported). + A plugin that puts a button that opens a dialog to paste in content from Word and similar + programs like wordpad. It will then filter out extraneous and bad html from the content + before injecting it into the RTE. Experimental as the filter list may not be complete yet. + Feedback is welcome and appreciated. Filters will be updated based on it. + +dojox.editor.plugins.InsertAnchor: + Status: Stable (supported). + A plugin that allows anchor points to be inserted into the document being edited. + The anchors are styled in the doc to make them easily visible/editable in the document. + +dojox.editor.plugins.TextColor: + Status: Experimental (unsupported). + A plugin that makes use of the dojox.widget.ColorPicker widget in lieu of the + dijit.ColorPalette. + +dojox.editor.plugins.NormalizeStyle: + Status: Experimental (unsupported). + A plugin that tries to normalize the output from the editor as either CSS styled or semantic (<b>, <i>, etc) + style. + +dojox.editor.plugins.StatusBar: + Status: Experimental (unsupported). + A plugin that adds a status bar and an optional resize handle to the footer of the editor. + +dojox.editor.plugins.LocalImage + Status: Beta + A plugin that adds local image upload and edit capability to the editor. + +dojox.editor.plugins.AutoUrlLink + Status: Experimental (Unsupported) + A plugin that adds auto url link creation capability as a headless plugin to the editor + +dojox.editor.plugins.ResizeColumnPlugin + Status: Experimental (Unsupported) + A plugin that adds column resize to the editor table plugins. + +dojox.editor.plugins.AutoSave + Status: Experimental (Unsupported) + A plugin that provides 'auto-save' capablity, eg, post back to some url at an interval. + +dojox.editor.plugins.SpellCheck + Status: Experimental (Unsupported) + A plugin that provides server-side spell-check support. + + +dojox.editor.plugins.SafePaste + Status: Beta (Supported) + A plugin that provides a safer paste function to the editor. It strips out script tags, + tries to fix up odd input from Word, Wordpad, etc. Very similar to PasteFromWord except that + it takes complete control of paste in dijit.Editor instead of being an alternate paste icon. + +------------------------------------------------------------------------------- +Dependencies: + +dijit +dojox.form +dojox.html.format +dojox.widget.ColorPicker +dojox.layout.ResizeHandle + +------------------------------------------------------------------------------- +Documentation + +The plugins directory contains extensions which work with dijit.Editor. + +See also: + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/TablePlugins.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/PrettyPrint.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/PageBreak.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/ShowBlockNodes.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/Preview.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/Save.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/ToolbarLineBreak.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/InsertEntity.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/NormalizeIndentOutdent.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/Breadcrumb.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/FindReplace.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/CollapsibleToolbar.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/Blockquote.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/PasteFromWord.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/InsertAnchor.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/TextColor.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/NormalizeStyle.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/StatusBar.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/LocalImage.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/AutoUrlLink.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/ResizeTableColumn.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/AutoSave.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/SpellCheck.html + http://dojotoolkit.org/reference-guide/dojox/editor/plugins/SafePaste.html +.html + +------------------------------------------------------------------------------- +Plugin Installation instructions + +Get dojo and dijit from svn. Include the Editor and plugins in your page: + +dojo.require("dijit.Editor"); + +For the TablePlugins: + dojo.require("dojox.editor.plugins.TablePlugins"); + and CSS: + <link href="[path]dojox/editor/plugins/resources/editorPlugins.css" type="text/css" rel="stylesheet" /> + +For the UploadImage plugin: + dojo.require("dojox.editor.plugins.UploadImage"); + and CSS: + <link href="[path]dojox/editor/plugins/resources/editorPlugins.css" type="text/css" rel="stylesheet" /> + <link href="[path]dojox/form/resources/FileInput.css" type="text/css" rel="stylesheet" /> + +For the PrettyPrint plugin: + dojo.require("dojox.editor.plugins.PrettyPrint"); + and CSS: + No CSS required. + +For the PageBreak plugin: + dojo.require("dojox.editor.plugins.PageBreak"); + and CSS: + <link href="[path]dojox/editor/plugins/resources/css/PageBreak.css" type="text/css" rel="stylesheet" /> + +For the ShowBlockNodes plugin: + dojo.require("dojox.editor.plugins.ShowBockNodes"); + and CSS: + <link href="[path]dojox/editor/plugins/resources/css/ShowBlockNodes.css" type="text/css" rel="stylesheet" /> + +For the Preview plugin: + dojo.require("dojox.editor.plugins.Preview"); + and CSS: + <link href="[path]dojox/editor/plugins/resources/css/Preview.css" type="text/css" rel="stylesheet" /> + +For the Save plugin: + dojo.require("dojox.editor.plugins.Save"); + and CSS: + <link href="[path]dojox/editor/plugins/resources/css/Save.css" type="text/css" rel="stylesheet" /> + +For the ToolbarLineBreak plugin: + dojo.require("dojox.editor.plugins.ToolbarLineBreak"); + and CSS: + No CSS required. + +For the InsertEntity plugin: + dojo.require("dojox.editor.plugins.InsertEntity"); + and CSS: + <link href="[path]dojox/editor/plugins/resources/css/InsertEntity.css" type="text/css" rel="stylesheet" /> + +For the NormalizeIndentOutdent plugin: + dojo.require("dojox.editor.plugins.NormalizeIndentOutdent"); + and CSS: + No CSS required. + +For the Breadcrumb plugin: + dojo.require("dojox.editor.plugins.Breadcrumb"); + and CSS: + <link href="[path]dojox/editor/plugins/resources/css/Breadcrumb.css" type="text/css" rel="stylesheet" /> + +For the FindReplace plugin: + dojo.require("dojox.editor.plugins.FindReplace"); + and CSS: + <link href="[path]dojox/editor/plugins/resources/css/FindReplace.css" type="text/css" rel="stylesheet" /> + +For the CollapsibleToolbar plugin: + dojo.require("dojox.editor.plugins.CollapsibleToolbar"); + and CSS: + <link href="[path]dojox/editor/plugins/resources/css/CollapsibleToolbar.css" type="text/css" rel="stylesheet" /> + +For the Blockquote plugin: + dojo.require("dojox.editor.plugins.Blockquote"); + and CSS: + <link href="[path]dojox/editor/plugins/resources/css/Blockquote.css" type="text/css" rel="stylesheet" /> + +For the PasteFromWord plugin: + dojo.require("dojox.editor.plugins.PasteFromWord"); + and CSS: + <link href="[path]dojox/editor/plugins/resources/css/PasteFromWord.css" type="text/css" rel="stylesheet" /> + +For the InsertAnchor plugin: + dojo.require("dojox.editor.plugins.InsertAnchor"); + and CSS: + <link href="[path]dojox/editor/plugins/resources/css/InsertAnchor.css" type="text/css" rel="stylesheet" /> + +For the TextColor plugin: + dojo.require("dojox.editor.plugins.TextColor"); + and CSS: + <link href="[path]dojox/editor/plugins/resources/css/TextColor.css" type="text/css" rel="stylesheet" /> + +For the NormalizeStyle plugin: + dojo.require("dojox.editor.plugins.NormalizeStyle"); + and CSS: + No CSS required. + +For the StatusBar plugin: + dojo.require("dojox.editor.plugins.StatusBar"); + and CSS: + <link href="[path]dojox/editor/plugins/resources/css/StatusBar.css" type="text/css" rel="stylesheet" /> + +For the LocalImage plugin: + dojo.require("dojox.editor.plugins.LocalImage"); + and CSS: + <link href="[path]dojox/editor/plugins/resources/css/LocalImage.css" type="text/css" rel="stylesheet" /> + +For the AutoUrlLink plugin: + dojo.require("dojox.editor.plugins.AutoUrlLink"); + and CSS: + No CSS required. + +For the ResizeTableColumn plugin: + dojo.require("dojox.editor.plugins.ResizeTableColumn"); + and CSS: + No CSS required in addition to the table plugins css. + +For the AutoSave plugin: + dojo.require("dojox.editor.plugins.AutoSave"); + and CSS: + <link href="[path]dojox/editor/plugins/resources/css/AutoSave.css" type="text/css" rel="stylesheet" /> + +For the SpellCheck plugin: + dojo.require("dojox.editor.plugins.SpellCheck"); + and CSS: + <link href="[path]dojox/editor/plugins/resources/css/SpellCheck.css" type="text/css" rel="stylesheet" /> + +For the SafePaste plugin: + dojo.require("dojox.editor.plugins.SafePaste"); + and CSS: + <link href="[path]dojox/editor/plugins/resources/css/SafePaste.css" type="text/css" rel="stylesheet" /> + +See tests for examples: + dojox/editor/tests/editorTablePlugs.html + dojox/editor/tests/editorUploadPlug.html + dojox/editor/tests/editorPrettyPrint.html + dojox/editor/tests/editorPageBreak.html + dojox/editor/tests/editorShowBlockNodes.html + dojox/editor/tests/editorPreview.html + dojox/editor/tests/editorSave.html + dojox/editor/tests/editorToolbarLineBreak.html + dojox/editor/tests/editorInsertEntity.html + dojox/editor/tests/editorNormalizeIndentOutdent.html + dojox/editor/tests/editorBreadcrumb.html + dojox/editor/tests/editorFindReplace.html + dojox/editor/tests/editorCollapsibleToolbar.html + dojox/editor/tests/editorBlockquote.html + dojox/editor/tests/editorPasteFromWord.html + dojox/editor/tests/editorInsertAnchor.html + dojox/editor/tests/editorTextColor.html + dojox/editor/tests/editorNormalizeStyle.html + dojox/editor/tests/editorStatusBar.html + dojox/editor/tests/editorLocalImage.html + dojox/editor/tests/editorAutoUrlLink.html + dojox/editor/tests/editorResizeTableColumn.html + dojox/editor/tests/editorAutoSave.html + dojox/editor/tests/editorSpellCheck.html + dojox/editor/tests/editorSafePaste.html + dojox/editor/tests/testPluginsAll.html |