PungoSpell Spell Checker for vB3.5 WYSIWYG and Standard mode

PungoSpell for vB 3.5 WYSIWYG and Standard mode

Intro: PungoSpell supports WYSIWYG mode disply using DHTML on the spell check popup window. It uses PHP's buitin PSPELL module. Many have this already compiled in, but if not, it's easy to add.

What this hack does This hack modifies the PungoSpell software package from PungoSpell to allow spell checking on vBulletin for both modes, WYSIWYG and standard mode.

Change Log:
v2.4 December 25, 2005: Security fix for cases where you allow HTML posts and they contain malicious code (Credit goes to Brendan Donahue for finding the issue and alerting TechGuy, and to TechGuy for alerting me to it)

v2.3 Bug fix standard mode.
v2.2 Bugfix
v2.1 Changed JS to handle vB 3.5 beta 4
v2.0 Initial release for vB 3.5 beta Features, no more config edits, uses admin panel for settings


Note: There's another hack for spell checker for vBulletin3 using PHPSpell. (I plan to port it to vB 3.5 shortly) You might want to compare both to decide which one you like best.
https://vborg.vbsupport.ru/showthrea...threadid=65723

Credit PungoSpell Is a free software using the MIT license. By default, it will work fine in standard mode. This hack will allow it to work for both standard and WYSIWYG.

Requirements: You will need to have PSPELL compiled into your PHP setup. Many have this by default. To find out if you already have it, check your PHP info from the vBulletin Admin Panel: Import & Maintenance > View PHP Info. Search for "pspell". If it's there, you're fine. If not, you can recompile PHP with the "--with-pspell" paramater.

You also need aspell software installed on your server with a dictionary setup.

Please check with your server admin if not sure


Installation Instructions

1. Download the attached file, and unpack into your main forum directory, except for pungo_install.php which should go into your admincp directory. Make sure the file "custom.pws" is writable by apache, otherwise the "Learn" function will not work.

2. Run pungo_install.php in the admincp directory. Once you're done, edit the options in the vB options menu under the title "PungoSpell".

3. It has English setup by default. If you want it to use any other language, it's easy. Just edit the language setting from your control panel.

"en" stands for English. Change it to the code of the language you want. Like "fr" for French, for example. Make sure your system has the required dictionary. You see the dictionary config by typing "aspell config" at the command line, to see which dictionaries you have.

4. Edit each template where you'd like to have the spell checker. For example:

newreply template

A. Find

</head>

Add above

<script src="pungospell.js"></script>

B. Add somewhere the followin (below $navbar for example)g:

      <form name="spell_form" id="spell_form" method="POST" target="spellWindow" action="pungospell.php">
                <input type="hidden" name="spell_formname" value="">
                <input type="hidden" name="spell_fieldname" value="">
                <input type="hidden" name="spellstring" value="">
             </form>

C. Find the submit and preview buttons:

				<input type="submit" class="button" name="sbutton" value="$vbphrase[save_changes]" accesskey="s" tabindex="1" />
		<input type="submit" class="button" name="preview" value="$vbphrase[preview_changes]" accesskey="p" tabindex="1" />

Add below:

<input type="button" class="button" value="Spell Check" onClick="spellCheck('vbform', '$editorid', '2');" />

And repeat the same steps for other templates like newthread etc.


Trouble shooting:

1. Learn doesn't work: Try this: Change the first line from custom.pws:

personal_ws-1.1 en 0

To:

personal_ws-1.1 english 0

en worked fine for me on Fedora and Gentoo, but I had to change to english on RHE.


2. Change language If you have learning enabled, affter you change the language from the admincp, you also, in the file custom.pws, the first line reads something like:

personal_ws-1.1 en 0

You will need to change en to the language you use, like fr


Please click Install if you have installed this mod.

[welo]

Originally Posted by tamarian

I just tested this, and was unable to reproduce this. When you preview, do you leave the spell check window open?

Nope. How can you? Soon as the alert window says "Spell checking complete" and you hit "ok" it closes the popup. The weird thing is you can continue with multiple edits as long as you don't preview. Soon as you preview the whole thing chokes.

I'm using Firefox 1.0.6 on W2K btw. Haven't checked it in other browsers yet.

[tamarian]

Originally Posted by welo

Nope. How can you? Soon as the alert window says "Spell checking complete" and you hit "ok" it closes the popup. The weird thing is you can continue with multiple edits as long as you don't preview. Soon as you preview the whole thing chokes.

I'm using Firefox 1.0.6 on W2K btw. Haven't checked it in other browsers yet.

I use Firefox 1.0.6, and it happens to be the browser I've tested with. I was able to preview, after spell checking, and the updated text appeard in the spell checker.

[welo]

Hmm. Okay then. Just in case I explained it incorrectly, here's exactly what I do to get the error:

1. Get to an editor and write anything (preferably something with spelling errors)
2. Spellcheck
3. Preview
4. Add anything else to your message
5. Spellcheck again

Whatever I have added won't show up in the spellchecker. However, if I add some more text, preview it and then spellcheck, it seems to work.

[welo]

Originally Posted by tamarian

(from hack description)
4. Edit each template where you'd like to have the spell checker. For example:
...
And repeat the same steps for other templates like newthread etc.

Since I notice that whenever spellchecker hacks traditionally show up around here, those are the recurring general instructions, while I installed PungoSpell this time I actually kept track of all my template edits . Here's the list:

• editpost - Adds the spellchecker to Advanced Mode editing (won't show up in the AJAX-generated version of the inline editor)
• New Posting Templates > newthread - Whenever a new thread is being posted
• New Posting Templates > newreply - When replying to an existing thread
• Private Message Templates > USERCP_SHELL, pm_newpm - Adds spellchecking to PM system. To do this one the <script src="pungospell.js"></script> script must go in the head of USERCP_SHELL, the <form name="spell_form"> code goes in the same template under the $navbar var, then the buttons are added to the pm_newpm template.
• Calendar Templates > calendar_edit - Adds spellchecking to calendar events. Note there are two sets of submit and reset buttons in this template. Your spellchecker button should go in the first of these (the buttons directly under all the hidden tags, not the button set at the end of the page).

I thinks that's it. Tried adding it to the contactus template for the board's contact form and for some reason it won't work there. Not entirely sure why.

Hope this helps someone .

[tamarian]

Originally Posted by welo

Hmm. Okay then. Just in case I explained it incorrectly, here's exactly what I do to get the error:

1. Get to an editor and write anything (preferably something with spelling errors)
2. Spellcheck
3. Preview
4. Add anything else to your message
5. Spellcheck again

Whatever I have added won't show up in the spellchecker. However, if I add some more text, preview it and then spellcheck, it seems to work.

O.k., I was able to reproduce it with these steps Will takea look and see if there's a way around it.

[tamarian]

Originally Posted by welo

Whatever I have added won't show up in the spellchecker. However, if I add some more text, preview it and then spellcheck, it seems to work.

Welo, give the new version a try. Download the zip, and just upload pungospell.js. Let me know how it goes.

[welo]

I think that did it, bud. Tried every way I could to break it and it works exactly fine now. Thanks for fixing it . This is a great hack. :up:

[Chadi]

is this better than vbspell?

[tamarian]

Originally Posted by chadi

is this better than vbspell?

I would say no. PSPELL and Aspell depend on your PHP compilation, and from past experience, some problems may occur when you upgrade PHP. So, a lot of things can go wrong. vB Spell is more stable, IMHO.

[welo]

Okay, I finally got a chance to work with skinning the spellchecker interface today and came up with a layout I think is pretty nice. Attached is an altered version of pungospell.php containing the template. Feel free to use it if you want (it's named welo-pungospell.php so naturally you have to rename it).

One thing I'm having trouble figuring out though, is how to get the iframe to use my fonts and background colors (IE6 is being especially stubborn about this). Might have to just rename it to a php file and import the css that way.