vBGlossary

I must pay homage to user/moderator wluke for this idea. I must also thank him for allowing me to run with it, and release it publicly. Thanks Wayne!

What's it do?
Simple: creates a glossary of terms. They're sorted alphabetically much in the same way the Memberlist is. I find this is extremely useful for most forums, which surely have a lot of their own lingo. For my site, it's a few acronyms and goofy phrases. My members get a kick out of referring newbies to the glossary to learn about the phrases. It's really helped the whole place seem less like a clique...because others can catch up easily with a reference like this.

Here's a live demo


What's it take?
This hack involves a MySQL command, the uploading of two files, the modification of one, and the creation of five templates. It also requires the modification of a second file, and of two templates, if you want to display a random glossary term on the New Reply/New Thread pages. It'll require a bit more still if you want to add the Glossary to your forum jump menu.

First off, run the following query in MySQL. This is the table that will store the glossary data.

CREATE TABLE `glossary` (
  `glossaryid` int(11) NOT NULL auto_increment,
  `text` text NOT NULL,
  `description` text NOT NULL,
  PRIMARY KEY  (`glossaryid`)
) TYPE=MyISAM;

Attched to the post right after this one is an archive: files.zip. This archive contains two files: glossary.php and admin_glossary.php. The first goes in your main forums directory. The second should be uploaded into your /admin/ directory.

Next, you'll need to create five templates. I've attached a text file containing all five to this post. Should be pretty straightforward. Mess with the formatting as you see fit, of course.

After that, you'll probably want to open (back it up!!!) your /admin/index.php file. Find the code below (around line 340):

makenavselect("Templates");
// ***

Right after that, add this:

makenavoption("Add", "admin_glossary.php?action=add", "|");
makenavoption("Edit", "admin_glossary.php?action=edit", "|");
makenavoption("Delete", "admin_glossary.php?action=delete");
makenavselect("Glossary", "<hr><br>");

There, it should work now! Now, on to the extras (well worth installing, in my opinion):

Display a random glossary term on new thread/new reply pages
Open newreply.php and find the following code (around line 468...it should be right near the end of the file):

getforumrules($foruminfo,$permissions);

Right after it, add this:

  $rand_term = $DB_site->query_first("SELECT text AS term_text, description AS term_description FROM glossary ORDER BY RAND()");
  extract($rand_term);
  $term_description = str_replace("'", "\\'", htmlspecialchars(strip_tags($term_description)));

Yeah, that last line is a little messy -- I like saving space, though.

Save and upload. Next, open newthread.php and find the same bit of code (duplicated below) around line 368 or so:

getforumrules($foruminfo,$permissions);

After that, add the same bit of code above.

Next: the templates. Find the below in both templates...

$vbcode_smilies</td>

...and in both templates, replace it with this:

	$vbcode_smilies<br><center><smallfont><b>Random Term: <a href="#" onclick="alert('$term_description'); return false;">$term_text</a></b></smallfont><br>

	<smallfont><a href="$bburl/glossary.php" target="_blank">More Glossary Terms!</a></smallfont><br></td>

There, you're done!


Add vBGlossary to the forum jump menu
Open forumdisplay.php in your main forums directory. Find this, near the top of the file (line 13 or so):

	case 'cp': $goto = 'usercp'; break;

Right after it, add this:

	case 'gl': $goto = 'glossary'; break;

Next (and last) step: open the forumjump template and add this bit of code somewhere amongst the other options...where you put it depends on where you want it in the menu.

		<option value="gl" $frmjmpsel[glossary]>The Glossary</option>

That's it! All done. Enjoy.

I hope you all enjoy this hack. It didn't take nearly as much time/effort as I thought it would...I really love it, though.

[Lucky]

Did any of you notice that the newreply.php and newthread.php get an error when you try to add what is said to be added to both?

Just wondering?

BTW:
I too am unable to add in admin cp.

[FWC]

Originally posted by Lucky
Did any of you notice that the newreply.php and newthread.php get an error when you try to add what is said to be added to both?

Just wondering?

BTW:
I too am unable to add in admin cp.

I never went that far. I just ran the query, uploaded the files and modified admin/index.php. I wanted to test it out first. But, it doesn't work. I feel like a moron. I've been messing with it all night and I can't figure out what's wrong with the admin file. I can add entries manually using the exact same query that's in the admin file. I'm missing something totally obvious.

[Lionel]

I am also getting 404 with both admin. Never went past that.

[Lionel]

in doformheader you put glossary. It should be admin_glossary.

[Lionel]

thanks.
You should replace every instance of doformheader with admin_glossary, since this is what you are posting, not glossary. Now up to the second part.

[FWC]

Originally posted by Lionel
in doformheader you put glossary. It should be admin_glossary.

You rule, Lionel! That did the trick. I'm still used to simple forms. Now I understand the vB admin ones a whole lot better.

[Lionel]

but you should fix your instructions in newthread and newreply templates. You should not replace the smilies code, but add next to it or you disappear smilies.... Great!
now up to last part

[Lucky]

Originally posted by Lionel
thanks.
You should replace every instance of doformheader with admin_glossary, since this is what you are posting, not glossary. Now up to the second part.

Ok.

I have replaced every instance of doformheader with admin_glossary instead of glossary and I am still getting the following:

CGI Error
The specified CGI application misbehaved by not returning a complete set of HTTP headers. The headers it did return are:

Any ideas?

BTW:
Which admin_glossary were you using?
The one from the 1st post or the update?

[Lionel]

Installed on 2.21. Works great. Now we have to poulate it. Who is going to be nice and give us some texts startup boost? :supwink:

[Lionel]

I used the second one. After problems, I downloaded it and never replaced it.