fix
[ikiwiki.git] / doc / todo / wikiwyg / discussion.mdwn
1 Very nice! There are some rough spots yes, but this looks exactly as I'd
2 hoped it would, and seems close to being ready for merging.
3
4 A few observations, in approximate order of priority:
5
6 * What's the copyright and license of showdown? Please include that from
7   the original zip file.
8  * Done. Check licences folder
9 * What happens if there are concurrent edits? The CGI.pm modification to
10   save an edited wikiwyg part doesn't seem to check if the source file has
11   changed in the meantime, so if the part has moved around, it might
12   replace the wrong part on saving. I've not tested this.
13  * When you click the edit button, the exact same protocol is used for saving.
14    However when you double click to edit, this still is possibly an issue.
15 * The stuff you have in destdir now really belongs in basewiki so it's
16   copied over to any destdir.
17  * Done.
18 * Personally, I'm not sure if I need double-click to edit a section in my
19   wiki, but I'd love it if the edit form in the cgi could use wikiwyg. Seems
20   like both of these could be independent options. Doable, I'm sure?
21  * Done.
22 * It would be good to move as much as possible of the inlined javascript in
23   wikiwyg.tmpl out to a separate .js file to save space in the rendered
24   pages.
25  * Done.
26 * Both this plugin and the [[Gallery]] are turning out
27   to need to add a bunch of pages to the basewiki. I wonder what would be a
28   good way to do this, without bloating the basewiki when the plugins arn't
29   used. Perhaps the underlaydir concept needs to be expanded so it's a set
30   of directories, which plugins can add to. Perhaps you should work with
31   arpitjain on this so both plugins can benefit. (The smiley plugin would
32   also benefit from this..)
33  * Done. All plugin files are now stored in a tarball. IkiWiki checks for
34    <plugin name>.tar.gz in the basedir and if the plugin is being used, then
35    it extracts the files to destdir. Currently IkiWiki does not render these
36    files though (my plugin doesn't need them to be rendered). However it wouldn't
37    be too hard to modify it to render them.
38 * Is there any way of only loading enough of wikiwyg by default to catch
39   the section double-clicks, and have it load the rest on the fly? I'm
40   thinking about initial page load time when visiting a wikiwyg-using wiki
41   for the first time. I count 230k or so of data that a browser downloads
42   in that case..
43  * Done-ish. I fixed it so that all of the javascript files(except for the main two)
44    are loaded after the content is loaded. It is possible to make is so that
45    the files are only loaded when you double click, however that is *a lot* 
46    more work, plus it will slow the load time for wikiwyg. But if you would
47    prefer that the files only load after double clicking, I can do that. Also,
48    I'm working on reducing the file sizes via [Javascript Compression][]. Theoretically,
49    I can get the size down to about 70kb, I'm working out the kinks now.
50
51 --[[Joey]]
52
53 Oh, by the way, let me know if I forgot to tarball anything. --[[TaylorKillian]] 
54
55 [Javascript Compression]: http://javascriptcompressor.com/