readme.txt
1GrenSladaWritezor v. 0.0.1
2GNU General Public License Version 2 (http://www.gnu.org/licenses/gpl.html)
3Created by Stanford Ng <stng@theculprit.com>
4
5This is a quick and dirty DokuWiki plugin I whipped up to try out full HTML editing. It adds a new tag <EMBEDDED_HTML>, and everything within is interpretted as full HTML. The editor uses FCKEditor to provide wysiwyg editing, although certain features had to be disabled as they don't play well with DokuWiki's XHTML renderer's default escaping. This is probably a "good thing" (tm) since allowing full HTML access is potentially a bit dangerous. Nonetheless, it's a bit tricky to tell what sequences will and will not break. The plugin is mostly used internally by a trusted group of users, so that was not a design priority. Also, right now, only one <EMBEDDED_HTML> section per page is supported. Feel free to mess around with it and try out lots of different ideas. It's in a very rough state right now, but I thought I'd throw it out there and get a sense of what the pain points are.
6
7Some interesting areas that I haven't had time to explore are:
8 1. Support for more than one <EMBEDDED_HTML> tag.
9 2. Support for the rest of FCKEditor's features - namely, image upload and font face don't work. Probably some other cool stuff too.
10 3. Auto-mapping between wiki text and the rich text editor. i.e. instead of using the <EMBEDDED_HTML> tag, the wiki syntax could be parsed and displayed wysiwyg, then parsed back into wiki syntax upon save. Kinda unsure if this is the way to go, but it wouldn't hurt to try that out.
11
12Re: Toolbar icon
13The toolbar icon, GrenSladaWritezor.png, needs to be copied to DokuWiki's lib/images/toolbar directory.
14
15Re: FCKEditor
16I embedded a copy of v. 2.4.1 of FCKEditor in the plugin to avoid an extra installation step. It's a vanilla distribution and the whole directory can be replaced with newer versions as they become available.
17
18Re: data/cache
19At times, it may be necessary to wipe out the data/cache directory to see the new pages.
20
21Big thanks to the following folks:
22 Andreas Gohr and the rest of DokuWiki folks
23 http://wiki.splitbrain.org/wiki:dokuwiki
24
25 The FCKEditor crew
26 http://www.fckeditor.net/
27
28 A.C. Henke, whose IPA plugin provided the method to hook into the toolbar
29 http://wiki.splitbrain.org/plugin:ipa
30
31 Tango guys for the great monkey icon. :) http://tango.freedesktop.org/Tango_Icon_Gallery
32
33That's all for now! Enjoy!
34
35
