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.

[mholtum]

Originally Posted by tamarian

What's the output of this command:

aspel config

It might be a dictionary name issue, some encountered it in the 3.0.7 thread:

https://vborg.vbsupport.ru/showthrea...threadid=65737

How do I run that command?

[tamarian]

Originally Posted by mholtum

How do I run that command?

You do it from an SSH console. Or, you can ask your admin for the config of aspell. While you're at it, ask the admin if there's a dictionary for 'en'.

A few more tips: Disable the Learn function, to see if this is due to custom.pws file issues.

[mholtum]

I disabled the learn feature and now it works!

[tamarian]

Originally Posted by mholtum

I disabled the learn feature and now it works!

Good to hear I think I made it disabled by default.

Now you can try a few things, if you want, to see if it can still work in learn mode. Visit the 3.0.7 thread, and you can try some of the solutions there.

I will also release another spell checker that doesn't need PSPELL compiled in, and uses MySQL instead.

[mholtum]

Thanks so much for the assistance.. I am not a n00b to hacking vb but I am to troubleshooting.. I love this feature as I am sure my members will as well, once I upgrade my live site... Thanks again.

[dreck]

*Great Hack*

But, I was wondering what is different about this & the one I saw in 3.5.0 beta 2?
I noticed VB added a spell check button & when clicking it It as me to install ieSpell.
I did not notice this in beta 1, but I wasn't looking for it?

[tamarian]

Originally Posted by dreck

But, I was wondering what is different about this & the one I saw in 3.5.0 beta 2?
I noticed VB added a spell check button & when clicking it It as me to install ieSpell.
I did not notice this in beta 1, but I wasn't looking for it?

It was only introduced in beta2.

The difference is:

vB's spell checking is client side and requires Windows, IE and ieSpell downloaded and installed on each PC.

PungoSpell is server-side, and works on any platform and most browsers. Your members don't need to install or configure anything.

Check this post on vb.com for more details:

http://www.vbulletin.com/forum/showp...4&postcount=17

[Martin]

How would this, especially porting to MySQL, affect large boards? It seems that if you have 300 users all checking their spelling at the same time, it might cause some probs.

[tamarian]

Originally Posted by Martin

How would this, especially porting to MySQL, affect large boards? It seems that if you have 300 users all checking their spelling at the same time, it might cause some probs.

It's on my to-do list to generate some benchmark numbers between PungoSpell and PHPSpell. Large boards can restrict these features to usergroups if they see any performance issues.

[dreck]

Originally Posted by tamarian

It was only introduced in beta2.

The difference is:

vB's spell checking is client side and requires Windows, IE and ieSpell downloaded and installed on each PC.

PungoSpell is server-side, and works on any platform and most browsers. Your members don't need to install or configure anything.

Check this post on vb.com for more details:

http://www.vbulletin.com/forum/showp...4&postcount=17

Thanks for the reply, I will definally read up before I deside.
Thanks!