e3d1b3927e55358fad1826c0e8f7f7eff987a70e
[ikiwiki.git] / doc / todo / wikiwyg.mdwn
1 [Wikiwyg](http://www.wikiwyg.net/)
2 is a WYSIWYG editor written in javascript for wikis. It allows editing in a
3 gui or in wikitext and converts edits back to wiki format to be saved to
4 the wiki.
5
6 It would be awesome to use this in ikiwiki, but to take full advantage of
7 it with ikiwiki, it would need to know about MarkDown. Wikiwyg does allow
8 defining the text that is stuck on each side of a given html element to
9 make it wikified, for example, it can add "# " for a h1, "[[" and "]]" for
10 a link, etc. This seems easily doable.
11
12 The other thing that would need doing is a `saveChanges` function would
13 need to be implemented that saves the text back to ikiwiki. 
14 http://svn.wikiwyg.net/code/trunk/wikiwyg/share/Kwiki/lib/Wikiwyg/Kwiki.js
15 seems like a good starting point for building a submit form on the fly.
16
17 One other problem: Wikiwyg works by parsing html from a div, turning it
18 back into the wiki markup, and editing/saving that. That seems to assume
19 that there's a way of parsing a page's html and getting back to the underlying
20 wiki markup, which is not always the case in ikiwiki. Unless there's some 
21 other way to feed it the actual source for a page, this seems like a
22 problem. According to the developers, it is possible to do that, and start
23 off in WikiText mode.
24
25 [[!tag soc]]
26
27 [[!tag wishlist]]
28
29 [[!tag patch]]
30
31 Project IkiWiki::WIKIWYG v1.6 - <http://ikiwiki.xbaud.com/>
32 ===========================================================
33
34 [Wikiwyg][] is a "What you see is what you get" editor for wikis. It will allow you to double click on the text in a wiki and save it without reloading the page. The IkiWiki version will allow you to edit your wiki in Markdown or WYSIWYG. You will also be able to edit a page with the wikiwyg editor by clicking the "Edit" link at the top of the page.
35
36 This plugin requires that you have Archive::Tar intalled.
37
38 The plugin can be downloaded from <http://ikiwiki.xbaud.com/wikiwyg-1.6.tar.gz>
39
40 ### Installation Instructions
41
42 1. Copy the files from the wikiwyg tarball to the corrosponding folders in your ikiwiki installation
43 2. Add "wikiwyg" (no quotes) to the add_plugins section of your ikiwiki.setup
44 3. Rebuild your wiki
45 4. That's it!
46
47 ### Current Issues
48
49 * Some versions of Mozilla Firefox require you to click Wysiwyg, then another mode, then Wysiwyg again to get Wysiwyg mode working in the Edit link
50 * Double lists don't work
51
52 ### Upcoming Features
53
54 * More supported ikiwiki plugins (such as img, smilies, etc.)
55 * More wiki languages (such as wiki and otl)
56 * Ability to upload directly through wikiwyg (pending the upload plugin)
57 * Personalized settings
58
59 [Wikiwyg]: http://www.wikiwyg.net/