Changes between Version 12 and Version 13 of CkEditorPlugin
- Timestamp:
- Mar 19, 2015, 10:40:27 AM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
CkEditorPlugin
v12 v13 1 1 [[PageOutline(2-5,Contents,pullout)]] 2 2 3 = CKEditor Wysiwyg Plugin =3 = CKEditor Wysiwyg Plugin 4 4 5 == Description ==5 == Description 6 6 7 7 Wysiwyg wiki editor plugin using the open-source [http://ckeditor.com/ CKEditor], inspired by TracWysiwygPlugin. 8 8 9 '''N OTE: The `full_integration` mode is not recommended for use in production! It is still experimental, and under massive development.'''9 '''Note''': The `full_integration` mode is not recommended for use in production! It is still experimental, and under development. 10 10 11 The plugin does not contain the [http://ckeditor.com/ CKEditor] source (get it from their [https://svn.ckeditor.com/CKEditor SVN] - require >= 3.6).11 The plugin does not contain the [http://ckeditor.com/ CKEditor] source. Get it from their [https://svn.ckeditor.com/CKEditor SVN] - require >= 3.6. 12 12 After installation of both the plugin and [http://ckeditor.com/ CKEditor], set the `[ckeditor] editor_source` option for this plugin to the path of the CKEditor `ckeditor.js` script. 13 13 … … 19 19 || `none` || No integration - plain old textarea || 20 20 21 ''Using `CKEditorPlugin` looks like this'':21 Using `CKEditorPlugin` looks like this in Trac: 22 22 23 23 [[Image(sample.png)]] 24 24 25 26 The `full_integration` mode is the holy grail, but currently just a handful of elements are supported in this mode (see the [source:ckeditorplugin/trunk/ckintegration/htdocs/tracwiki.js tracwiki plugin] for details on that) - '''help with this is needed! ''' 25 The `full_integration` mode is the holy grail, but currently just a handful of elements are supported in this mode, see the [source:ckeditorplugin/trunk/ckintegration/htdocs/tracwiki.js tracwiki plugin] for details. 27 26 28 27 Disclaimer: 29 - Does not co-exist with TracWysiwygPlugin -have only one of them enabled.28 - Does not co-exist with TracWysiwygPlugin, have only one of them enabled. 30 29 - When using the `html_wrapper` mode and editing an existing wiki page, the page will be rendered in HTML upon save (macros are lost, etc.) 31 30 32 == Known Bugs / Limitations == 33 34 - marker and text color is not working in headers (see [http://groups.google.com/group/trac-dev/browse_thread/thread/a6d12d574c3544ca Google-Groups]) 35 - when inserting an image, only full path to image is working 36 - when entering a link manually, it is printed with an exclemation mark, see #9562 37 - Escaping of CamelCase words is only working the first time, see #9563 38 - copying lists from MS Word (tested with Word 2003) is not always working completely (in some browsers it the deep intention is lost) 39 40 == Help Wanted == 41 Help wanted for further development: 42 - Killer Feature: Support TracWiki syntax (by HTML<->TracWiki conversions? or by making CKEditor's rendering engine emit TracWiki?) 43 - Insert !WikiLinks using cool dialogs (e.g. choose existing page from TitleIndex, insert link to stubbed page & open new tab to create the stubbed page) 44 - Insert other kinds of TracLinks using cool dialogs (changesets, tickets, other resources...) 45 - Insert images intuitively (selector from attachments / repositories / upload from file-system as attachment or into repository, maybe even drag-and-drop) 46 - Macro-awareness - select macro to insert from supported macros, expand inserted macros inline 47 48 == Bugs/Feature Requests == 31 == Bugs/Feature Requests 49 32 50 33 Existing bugs and feature requests for CkEditorPlugin are … … 54 37 [http://trac-hacks.org/newticket?component=CkEditorPlugin&owner=itamarost&release=0.12 new ticket]. 55 38 56 == Download == 39 [[TicketQuery(component=CkEditorPlugin&group=type,format=progress)]] 40 41 == Download 57 42 58 43 Download the zipped source from [download:ckeditorplugin here]. 59 44 60 == Source ==45 == Source 61 46 62 47 You can check out CkEditorPlugin from [http://trac-hacks.org/svn/ckeditorplugin here] using Subversion, or [source:ckeditorplugin browse the source] with Trac. 63 48 64 == Installation == 49 == Installation 50 65 51 Install the plugin: 66 52 {{{ 67 53 #!sh 68 $easy_install http://trac-hacks.org/svn/ckeditorplugin/trunk54 easy_install http://trac-hacks.org/svn/ckeditorplugin/trunk 69 55 }}} 70 56 … … 72 58 {{{ 73 59 #!sh 74 $mkdir /path/to/trac-env/htdocs/js75 $svn checkout http://svn.ckeditor.com/CKEditor/releases/stable /path/to/trac-env/htdocs/js/ckeditor60 mkdir /path/to/trac-env/htdocs/js 61 svn checkout http://svn.ckeditor.com/CKEditor/releases/stable /path/to/trac-env/htdocs/js/ckeditor 76 62 }}} 77 78 79 == Configuration ==80 63 81 64 Enable it from the Plugins section of the Administration panel, or by adding the following to the `[components]` section of your `trac.ini`: … … 86 69 }}} 87 70 88 === Options ===71 === Configuration 89 72 90 73 The following options can be specified in the `[ckeditor]` section of your `trac.ini`: … … 111 94 You can also type `[[TracIni(ckedior)]]` in any Wiki-Page to get a list of possible options and their descriptions; see also description in plugins-panel. 112 95 113 114 96 == Example == 115 97 116 Sample configuration (default values shown):98 Sample configuration of a `trac.ini` file (default values shown): 117 99 {{{ 118 100 #!ini … … 123 105 }}} 124 106 125 == Recent Changes ==107 == Known Issues / Limitations 126 108 127 [[ChangeLog(ckeditorplugin, 5)]] 109 - marker and text color is not working in headers (see [http://groups.google.com/group/trac-dev/browse_thread/thread/a6d12d574c3544ca Google-Groups]) 110 - when inserting an image, only full path to image is working 111 - when entering a link manually, it is printed with an exclemation mark, see #9562 112 - Escaping of CamelCase words is only working the first time, see #9563 113 - copying lists from MS Word (tested with Word 2003) is not always working completely (in some browsers it the deep intention is lost) 128 114 129 == Author/Contributors == 115 == To do 116 117 Help wanted for further development: 118 - Killer Feature: Support TracWiki syntax (by HTML<->TracWiki conversions? or by making CKEditor's rendering engine emit TracWiki?) 119 - Insert !WikiLinks using cool dialogs (e.g. choose existing page from TitleIndex, insert link to stubbed page & open new tab to create the stubbed page) 120 - Insert other kinds of TracLinks using cool dialogs (changesets, tickets, other resources...) 121 - Insert images intuitively (selector from attachments / repositories / upload from file-system as attachment or into repository, maybe even drag-and-drop) 122 - Macro-awareness - select macro to insert from supported macros, expand inserted macros inline 123 124 == Recent Changes 125 126 [[ChangeLog(ckeditorplugin, 3)]] 127 128 == Author/Contributors 130 129 131 130 '''Author:''' Edan Maor, [wiki:itamarost] [[BR]] 132 '''Maintainer:''' [ wiki:itamarost] [[BR]]131 '''Maintainer:''' [[Maintainer]] [[BR]] 133 132 '''Contributors:''' framay