PungoSpell Spell Checker for vB3.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

Add above


B. Add somewhere the followin (below $navbar for example)g:
C. Find the submit and preview buttons:

Add below:
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.

Awesome hack Would install if I was running 3.5. :p

Awesome! thanks so much!

[high]* mholtum installs
[/high]

When I click "Spell Check" I get this error in the popup window.
here is line 44:

Do you know if your PHP is compiled with PSPELL support?

You can find out by going to your admin panel -> Maintenance -> View PHP info

It should show a table for PSPELL and indicate it's enabled. If not, you may need to recompile PHP

I looked and couldn't find it.. How would I recompile PHP?

I contacted my host, and he replied:

it is not installed, but it can be.

I will take care of this tomorrow.

Are you the server admin of your box? It could be tricky if you haven't done it before, so it's best to test on a test machine first. Here's how to do it:

http://www.vbulletin.com/forum/showthread.php?t=69072

You just need to add this in the PHP compile config step "--with-pspell"

I am not the admin of my server, but I shot him an email and he is going to install it for me tomorrow.. Thanks for the imput.

Very nice.

But also seems like the vB developers have listened to the users and will be including a spell checker in Beta 2 (already active on vb.com).

Good luck, I hope all goes well :)

It's great to have the new ieSpell on vB. But keep in mind it only works for IE. Some of us don't have Windows, or IE :) Some, who use the ieSpell, would still prefer other spell checkers.

So this does work with other broswers?

Yes. The screenshots were taken of FireFox.

The spell checking in VB3.50b2 only works for IE, and is quite the anticlimax. You have to download some freeware software that plugs into IE (and IE only) and when you press the button on the WYSIWYG editor, it activates the program.

Much better spell checking capabilities are needed I think.

For those who installed it already, there were 2 useless lines in the template edits:

You can delete those, as they are not needed. If you don't want to remove them, that fine, it's not a problem :)

ok, my host installed pungo and I get this error in the popup window. See attatchment.

Is that an error trying to pull up the dictionary file? For suggestions?
107 foreach ($suggestions as $suggestion) {

What happens when you enter a normal sentence, with a misspelled word? Like "I can speel godd"?

I get a flash of error messages then the same error.

this is the line pulling the error

Do you know if your server has aspell and dictionaries installed?

My host emailed me saying "Aspell and Pspell have both been installed on Tahoe. In case you need it aspell is in /usr/bin/aspell"

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?

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.

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.

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.

*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?

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

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.

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

I keep getting a blank window for the Spell check. I only put it on the newreply to test, since it's a test board anyway.

I also noticed in the custom.pws file, your copy in your post says
personal_ws-1.1 en 0

the one I downloaded says personal_ws-1.1 en 2

I'm not sure what the difference is, don't think it matters, but thought I'd ask.

Any idea why I'd get a blank window? I haven't heard back from the host if we have aspell or not but we do have pspell, I did check.

Thanks.

When you tested, did you test as a user from the allowed usergroups? Make sure you have permission in the admin panel vB settings.

The number in custom.pws indicates the number of words added to the word list.

Yes, I did. We only have admins, mods and dummy accounts for this test board. I did what you said and changed the user group numbers in the vB options.

I use Netscape, (hate IE), and my friend, one of the other admins, is using Mozilla, we get the same thing.

I'll double check the user group numbers though, thanks for the quick reply. :)

Edit in:

What a moron... I put the number of users instead of the user ID. :nervous:

Note: PungoSpell does not yet work with Beta2, only beta1. An update will be posted when available.

I am guessing that if it won't work with Beta 2 then it also won't work with beta 3 as I am getting the following errors:

Correct. The editor code iseems to change in each of the the beta stages, I'll wait for an RC release first, to avoid these problems.

Will this hack work on RC2 I wonder?

Yes, it should work fine. Also check vB Spell, it's easier to setup :)

I have installed it already so you're too late. :p And by the way, I can install any hack. I don't have any troubles while installing them. Besides, it looks like Pungo is much better than vB Spell one.

Also, is there any chance you could change this hack to a plugin?

Not sure what you mean. The hack does not require any changes to vBulletin's code.