WYSIFTW: Difference between revisions

From Meta, a Wikimedia project coordination wiki
Content deleted Content added
→‎To do: added some thoughts, perhaps move this to JIRA ?
Replaced content with '{{MovedToMediaWiki}}'
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{MovedToMediaWiki}}
'''WYSIFTW''' (formerly '''WYSIWTF''') is a JavaScript-based tool originally written by [[:en:User:Magnus Manske|Magnus Manske]]. Its primary purpose is to make it easier to edit wikipedia articles, especially for people unfamiliar with the intricacies of MediaWiki syntax (the vast majority of the planet, in case you forgot :-). This is achieved by creating a full-screen editing interface where the user can edit "augmented wikitext", that is, wikitext that has some "ugly" parts folded away by default, inline display of images etc. It has been tested on en.wikipedia, but should work elsewhere as well.

== Installation ==
You can install WYSIFTW yourself to test it. Just add the following line to your "vector.js" user subpage:
document.write('<script type="text/javascript" src="http://toolserver.org/~magnus/wysiwtf/wysiwtf.js"><\/script>');

== Code ==
The current code is in the toolserver SVN, [https://fisheye.toolserver.org/browse/Magnus/wysiwtf here]. wysiwtf.js is the live version, wysiwtf_dev.js the development one. The other files are required as well.

== Implemented function ==
* Basic editing : Typing, delete/backspace, cursor movements, click-to-edit
* Internal links are recognized and turned into "blue" links, where the label can be edited like any other text. Double-clicking the link allows the user to edit the link target.
* Images are recognized and shown in-line. Thumbnail text can be edited like any other text. Double-clicking the image allows the user to edit the image name.
* Templates are recognized and put into green, dotted boxes. The template name is shown in bold; if there are no parameters, the template name is shown in italics. Templates with a long paramater list are automatically folded, that is, the parameters are hidden by default. Double-clicking the template name toggles the parameter list, which can then be freely edited. This works for nested templates as well.
* HTML tags are visually highlighted to separate them from the normal text.
* References are collapsed, similar to templates. The full reference text can be toggled by double-clicking the &lt;ref&gt; tag. Self-closing reference tags ("&lt;ref/&gt;") are treated like normal HTML tags.
* External links
* Built-in diff function
* Built-in preview function

== To do ==
* "Advanced" editing: selection of text, advanced cursor movements
** copy/pasting (listen for paste command like for backspace/space/return), then access the paste (cross-browser?) and loop through character by character as if typed (can't be inserted anyway since it's not input/textarea)
* Bold/italics
* Lists
* Tables
* Support more image properties in image dialog
** Allowing changing filename, thumb frame or neither, left right or neither, caption/title (depending on thumb/frame or not), size (optional for thumb)

== Screenshots ==
<gallery>
File:WYSIFTW_screenshot_1.png|This is the WYSIFTW edit mode. One can edit directly in this page. Note the inline images, folded references, the unfolded reference entry in the second paragraph, and the template at the bottom (green). Article is [http://en.wikipedia.org/wiki/Antbird Antbird].
</gallery>

[[Category:MediaWiki Development]]
[[Category:Usability]]

Latest revision as of 00:55, 17 January 2011