New Posting Features - Automatic Thread Tagger (Project Terminated)

This modification has now been taken over by Phalynx updates/information etc can be found here:

https://vborg.vbsupport.ru/showthread.php?t=185495

Do not post on this thread, or mark this thread as installed.

Old Post:

Unfortunately I find myself in a position where continued development of this modification is not possible. So as of today (29/05/08) this project is terminated. If you are a coder feel free to take this project on and take it from beta to gold.

Automatic Thread Tagger v1.0
Beta 3

THIS IS A BETA MODIFICATION

Please read the entire post before diving in

If you report a bug please post the thread title that created it, without this I cannot test it and improve the language parsers

When a user submits a new thread this product will automatically take keywords from the thread title and use these as tags.

As an example, if a user submits a thread with a title of:

The thread will be automatically tagged with:

• Fish
• Food
• Cats

If the user also submits an actual tag of "Fish" this will not be duplicated. Additionally this product hooks in before vBulletin processes tags so any rules you have setup for this will be respected. It also checks if you have tagging enabled, if not the product does nothing.

If you choose to do so this product will also automatically tag threads created by incoming RSS feeds.

And if all that wasn't enough there is a whole load of different configuration options.

Installation

If you have a previous beta version of this modification install this MUST be uninstalled before proceed to install this version

1. Download the modification zip file to your local machine and extract the contents.
2. Upload the functions_autotagger.php to your includes folder (the same directory as your config.php)
3. Goto "ACP -> Plugins & Products -> Manage Products".
4. Click "Add/Import Product".
5. In the "Import Product" section, click the browse button and select the downloaded XML file (product-auto_thread_tagger.xml).
6. Click "Import"

After install, and by default the modification is disabled, this will allow you to play around with configuration before switching it on.

Configuration
Configuration for this product can be accessed via:

ACP -> vBulletin Options -> Automatic Thread Tagger

Each configuration entry has a description against it, so I won't rehash it all here. However the following configuration items are worth mentioning:

Disable Auto Tag if Tagged?

If this option is enabled and a user submits tags with their post then the title keywords will not be added.

Use Smart Quotes?

If this option is enabled (default) then the auto tagger will treat quoted terms as a single tag. For example if a user submits a title of:

The tags will be:

• great
• technical
• website

However if they submit a title of:

The tags will be:

• great
• technical website

Filter / Replacement Characters

This is the heart of the modification, as we are dealing with human input it can be rather complicated for a machine to handle and parse meaningful keywords. This configuration area allows you to configure filter and replacements for incoming thread titles. For example, you might not want & in your tags, through the options here you can filter it out or replace it with and.

In addition to this you can also use filter/replacements to extend tags. So if you run a motorbike website you might want to extend the term "GSXR" to "Suzuki GSXR" or change it completly to "Fast Bike".

Filters/replacements do not change titles, they only effect the resulting auto tags.

This configuration area is pre-populated with a series of default rules, these rules are based on my experience during development and should cover most things. However as mentioned this is a beta modification and we are dealing with human input so with your help and input this list will be improved.

Composite Tags

With composite tags you can define a collection of words to use a single tags. So if for example you specify a composite tag of "brown dog", and the user submits a title of "I love my brown dog" the tags will be "love, brown dog" without this composite tag the tags would be "love, brown, dog"

RSS Feed Additional Tags

If you use this modification to tag RSS created threads, you can also specify additional tags to add for each RSS feed. So for example if you have a feed from BBC News, in addition to the title based tags, you could also tag each thread with "General News".

In summary the other configuration values allow you to:

• Globally enable or disable the product (default is off).
• Exclude forums by id
• Exclude usergroups by id
• Exclude user by id
• Exclude words from the search words stop list (default is on). This excludes words like can, by, do, etc (open includes/searchwords.php for a full list). I would strongly recommend not disabling this, however you could and then use the following:
• Define your own list of exclude words.
• Exclude RSS feeds by feed ID.

Using this to tag RSS feeds

Unfortunately vBulletin does not include (that I can see) a hook that is called when an RSS thread is created. This means that it is not possible to hook into the code and perform auto tagging. All is not lost though, however it does require an edit to one of the default vBulletin files.

This is what you need to do:

• Open includes/cron/rssposter.php
• Find the following line:
  
  

  $itemdata->set('ipaddress', '');

• On a new line immediately after this paste in:
  
  

  require_once(DIR . '/includes/functions_autotagger.php');
  $autotags = GetAutoTags($itemdata->fetch_field('title'), "", true, $itemdata->fetch_field('forumid'), $feed['userid'], $item['rssfeedid']);
  $itemdata->set('taglist', $autotags);

• Save the file and place on you server.

Once this is done, and you have enabled RSS tagging in the configuration then RSS threads will be tagged.

I will find a solution to this as I really don't like the idea of having to edit files in this fashion. So if anybody can suggest a better way of doing this please speak up as it will mean I can get the solution out quicker.

Other Information

At the moment this product is most definitely in beta testing, once I and the people using it are happy with the product then I may consider releasing a hack that will tag all existing threads. Releasing this right now would probably cause more trouble than it is worth.

Parsing the thread text for tags is an extremely unlikely addition as this would require some fairly heavy processing to ensure quality of tags.

At the moment I am primarily concentrating on the parsing of human language and refining the filters/replacements. So adding Ajax support (i.e. auto populate the tag box as user enter words into the thread title box) is on the todo list however this won't happen until we are happy that the parsing system is as good as it can be.

One thing the product does not do which you may want to consider is change the "Separate tags using a comma." phrase used on the new thread post screen. You might want to consider changing this to something like "Separate tags using a comma, do not include words from your title". This depends on your personal preference and how you have the product configured.

Disclaimers
Obviously the input this product uses comes from human beings, therefore it is almost impossible to code for every single possible scenario. As such there is always a possibility that a specifically crafted submission may cause problems. I strongly suggest running this through some tests before committing to installing this on a live forum.

Ahh yes, one final thing - this is the first time I have created a product XML file, I have tested and install this and all seems fine - but it would be great if somebody in "the know" could cast an eye over it for obvious errors/issues.

Actually, one more one final thing, if you install it please click install

Hold on, one more one more one final thing, if you really like this mod then why not nominate it for MOTM

Release History

1.0 Beta 1
First Release

1.0 Beta 2

• Added filters/replacements
• Added RSS support
• Added RSS inclusion/exclusion support
• Added composite tags
• Added ability to tag all RSS threads with a specific tags (per RSS id)

1.0 Beta 3
Bug fix release

• Fixes issues with escaped characters
• Removed option to process filters on full title rather than potential tags.

[Stubbed]

This is an example of a perfect mod. It's taking an area that vB is lacking in and making it work a heck of a lot better.

I'll install once all the reported bugs are sorted

[shlomot]

I second this request. Thanks.

Originally Posted by Mesohu

Can you create a tool for creating/adding tags for all old threads ?

And thank you for this cool mod in general.

[xuanhuy238]

I'm vietnamese
I Tested this title : " Đóng góp ý kiến "
It generated these tags : góp,Đóng,kiến .
but I need: "Đóng góp,ý kiến
Any solution to fix this too ???I think this mod need 1 custom libarary muitiply word

[DDad]

It doesn't create tags for our rss feeds. Anyone else have this problem?

[mry]

how add old thread auto tag...

[djbaxter]

Originally Posted by MrEyes

As it seems to be the thing to do, I reserve the right to reserve the first post

EDIT: As usual after I submit the mod I find another one that does the same thing that was posted before mine Anyway, you might want to look at this one as well:

https://vborg.vbsupport.ru/showthread.php?t=179772

Originally Posted by Madlike

Idea ;

https://vborg.vbsupport.ru/showthread.php?t=179772

Isn't it ??

Originally Posted by jhamaican

can anyone tell me what the difference is between this mod and https://vborg.vbsupport.ru/showthread.php?t=179772 ?

That other mod requires file edits, which means you'll have to reapply them for every upgrade. This one is an imported product with no file edits.

[Jase2]

This is a lot better than the other, no hacking yourself into the source code.

However, one question ;

What if a user submits tags, does this stop adding them automatically? Also, are there any extra queries ect. we should know about?

[MrEyes]

Originally Posted by xuanhuy238

I'm vietnamese
I Tested this title : " Đ?ng g?p ? kiến "
It generated these tags : g?p,Đ?ng,kiến .
but I need: "Đ?ng g?p,? kiến
Any solution to fix this too ???I think this mod need 1 custom libarary muitiply word

This will be added in the next release

Originally Posted by Mecho

I Tested this title : " This is a TEST for Auto Tagger v1.0 "
It generated these tags : Test,Auto Tagger,v\.1\.0.

Originally Posted by ecihanuysal

i have a problem with parenthesis

A solution of sorts will be created in the next release (see comments at the end of this post)

Originally Posted by Junkie

Great MOD. Would it be possible for tags associated with a deleted thread to remove themselves also?

I believe the default vBulletin software will do this.

Originally Posted by paramegsoft

please how i can active auto tags to rss forums which get threads automatic

Working on this, see comments at the end of this post

Originally Posted by Jase2

What if a user submits tags, does this stop adding them automatically? Also, are there any extra queries ect. we should know about?

See the following:

The product does of course add some additional processing when a user submits a thread but this primarily uses what VB already has in memory so the impact is fairly low. It does not add any additional SQL queries.

In response to a few questions posted so far:

1) At the moment it does not support posts created via incoming RSS feeds, however I do intend to add this feature and I am in fact working on this right now.

2) As mention in the opening posts the product will not "retro-tag" already existing posts, the reason for this is that at the moment this is in beta and retro-tagging 1000's of posts with the current version could feasibly create alot of problem. Once the rule sets are defined then I will release something that will auto tag all existing threads.

3) As reported by a few people there are a few issues with non alphanumeric characters in titles (thing like ( ) \ /). The next version will have a fairly complex replacement system built once released this will allow you to perform filtering and replacements. So for example:

'\'=>' and '

will replace all instances of '\' with ' and '

This can also be used to extend tags, so for example you can set the following rule:

'GSXR'=>'Suzuki GSXR'

So if a user submits a title of "GSXR Paintwork", the tags will be "Suzuki GSXR, Paintwork"

I imagine that this replacement system will need, with your feedback, considerable tweaking to make it as good as it can be when process human language input.

4) Under the default configuration if the user submits tags with their thread then keywords from the title are still calculated but it will not duplicate. So for example if a thread title of "Fish food for cats" and tags of "pets, fish" are submitted, the final tags will be "pets, fish, cats". However the if the "Disable Auto Tag if Tagged?" option is enabled then if a user submits tags then the auto tagger will not do anything.

I am working on all this at the moment once I will release it as soon as I am happy that the changes are as good as they can be with single user/site testing.

And finally, thanks for the support it makes putting this together worthwhile

[Jase2]

Thanks for explanation. Looking forward to a more 'stable' release.

[Newfarm]

This is really cool and, while not disrespecting the other guy's addon, a better piece of work to administer then 'the other' addon that does the same.

I'll echo my support from the other addons thread for something though;

AJAXifying it, making the 'tags' field autoupdate based on the title input. Make it just do the calculations and populate the 'tags' field when focus is removed from the 'title' field.

(Not being a coder enables me to use 'just' in all sorts of places, especially those where I know there'll be a lot of work to get it going .)