User:Pilaf~enwiki/InstaView

InstaView is a nifty extension to Mediawiki's edit mode which can generate instantaneous previews (thus the name) of the wiki-text being edited. You might be thinking, "Hey, Mediawiki does previews already!", however this is unlike the ordinary preview in that it gets generated right inside your browser, on the fly, no waiting for the preview to load, it's instantaneous.

Requirements

All you need to use InstaView is a web browser with modern JavaScript support and have it enabled when editing a page. These are the browsers in which I've tested it and know that works:

• Gecko based: Mozilla Firefox, K-Meleon, Camino, etc.
• KHTML based: Konqueror and Safari
• Microsoft browsers: Internet Explorer5, 6, 7 & 8
• Opera 8.53 and later

On the following browsers it does not work:

• Does not seem to work on Firefox 3.5

If you've tested it on any other browsers, please feel free to add them to the corresponding list.

In terms of computing power, any modern computer should suffice. You may notice some delays when previewing very long pages on slow computers though.

Instructions

How do I install it?

SECURITY WARNING: By installing this script, you implicitly trust Pilaf not to use it for malicious purposes (the source code is open for anyone to read and modify, though).

Please check the requirements before you continue.

If you intend to install it on other wikis, read this. (This information is missing!)

To install simply copy/paste the full contents of User:Pilaf/InstaView/monobook.js into your own monobook.js page (Special:Mypage/monobook.js). Once you've done it refresh your browser as indicated at the top of your monobook.js' page. Note that you need to be a registered user in order for this to work.

*If you're not using the MonoBook skin, copy the contents to the right file from the table below instead of to monobook.js:

Skin	Filename
Classic	standard.js

You may want to configure a few parameters, such as your user name (for signatures). To achieve this simply edit the following line in your monobook.js:

window.onload = function () { InstaView.conf.user.name = 'User Name'; };

How do I use it?

If you've followed all the instructions above correctly, all you need to do now is edit a page. You should now notice a new button labeled InstaView right next to the old "Show preview" button. Once you've made your edits just click on InstaView to see the page appear instantly before your eyes. You may click it any number of times to see further changes, you'll never need to reload the page.

Troubleshooting

If you've installed it and still can't see it, try going through the following checklist:

• Check that you reloaded the page correctly (you can also try deleting your browser cache)
• Read the requirements to see if your browser is supported
• If nothing works, try messaging me

Limitations

InstaView is a work in progress and as such it has its limitations. Some are due to its state of incompleteness, some will most likely never happen as there are certain things that are just not possible to do without running on the servers. In any case you should be aware of what InstaView can and can't do, and never expect more, you can still use the regular preview for those cases where InstaView fails.

Here's a maintained list of the current limitations of InstaView (i.e. what it still can't do):

• <hiero></hiero> tags
• Templates and MediaWiki messages
• Undesired HTML stripping
• Table of contents
• Red links (to non-existing pages)
• Time tables
• Image galleries

In addition to the above list, it should be noted that InstaView is meant to be merely an approximation to the real thing and should not be considered 100% accurate. If in doubt use the regular preview.

In contrast, here is what IntaView currently can do:

• Headings (all levels)
• Regular paragraphs
• Horizontal bars
• Inline formatting (bold and italics)
• Wikilinks
• External links
• Numbered and unordered lists
• Definition lists
• Tables
• Preformatted text (whitespace at line start)
• Signatures
• Invisibile links (interwiki and categories)
• Images (with a few limitations)
• <nowiki></nowiki> tags (inline only so far)
• <math></math> tags (very limited)

Testimonials

Are you a happy user of InstaView? You can leave your testimonial here and let the world know how good it is :)

• Very impressive work, Pilaf!--Eloquence* 06:53, Feb 7, 2005 (UTC)

• I agree. I'm promoting it at Wikicities as well. :) Angela. 07:34, Feb 7, 2005 (UTC)

• This is very cool and works like a charm. Thanks, Pilaf! mu5ti/✏ 05:27, 8 Feb 2005 (UTC)

• Very handy for janitorial work. --Phil | Talk 13:14, Feb 9, 2005 (UTC)

• been using it for the better part of a week. Thanks. --Alterego

• A very handy tool. Best of all it's completely free to use! Thanks a lot Pilaf! --Yelhsa 14:29, Feb 17, 2005 (UTC) (I even used Live Preview to preview this testimonial!)

• Live Preview is cool! I use it a lot, especially when editing on slow systems. Thank you Pilaf! — mark ✎ 21:23, 8 Mar 2005 (UTC)

• Hi! Richie did indicate to me this page. I will use the live preview if I am online. I also find it very good. But my question to Richie was different; I would be interesting to install a real wikipedia software on my PC for two reasons: a/ so, I can work long hours in my garden next summer (I have no internet connection in this part of the house), and b/ I can save my pages like an ready to work original on my PC including templates etc. without to have to risk changes that I don't want, mistake in what different "wiki kings", "king trolls" like netoholic in simple english, are specialists... can you say me if it is possible and what is to do? --oui 16:49, 27 Apr 2005 (UTC)

• Note so good for math, even with simple HTML tag like . Try editting this page with Live Preview and you will see what I mean: http://vi.wikipedia.org/wiki/%C4%90%E1%BB%8Bnh_l%C3%BD_c%E1%BB%99ng_h%C3%A0m_c%E1%BA%A7u_%C4%91i%E1%BB%81u_h%C3%B2a Tttrung 10:03, 13 September 2005 (UTC)

• Very nice work. Very useful on a slow connection. --Blackcap | talk 02:01, 23 September 2005 (UTC)

• Very nice extension. I only installed it a few minutes ago, and I'm already hooked! 11 points out of 10. κаллэмакс 13:12, 5 February 2006 (UTC)

• Used it with google gears to create an offline wiki! Very, very fast! Zvi 21:25, 9 July 2007 (UTC)

• Thanks for this. I used it today to create a wikipedia word count app at wikiwordia.com - Mahemoff 15:54, 10 October 2008 (UTC)

• Just tried installing it and it doesn't seem to work. Is anyone still supporting this? --Zvika (talk) 19:24, 15 November 2009 (UTC)

Who's using it?

For users inside this wiki this should give you a clue: clicky.

License

InstaView is distributed under the BSD license.

Development and updated versions

• An updated (development) version (not heavily tested yet) can be found at User:Pilaf/InstaView/Devel.
• A copy of InstaView for embedding this tool in other applications (like the in-browser editor wikEd) can be found under User:Pilaf/include/instaview.js. Please update this version for each new stable InstaView.