Add-On Releases - Topic (incl. Blog) of the Week/Fortnight/Month Nomination v1.636

On my board (USS Enterprise, NCC-1701-D), we get many comments daily or weekly on many different topics and there are so many topics in the community that to be honest, we had a tough time remembering the topic being reviewed to offer a timely comment or response. Obviously, we needed a weekly/monthly topic nomination system with which we could get our community to commit to one topic as a group and then comment on it during the course of the week/month.

Cruising vB.org at warp speed, I failed to find a nomination system readily available. Hence, I quickly wrote this mod (on my way to the bridge).

Acknowledgement:
This release would not have been quickly possible without the existence of most hacks released at vB.org, especially the "Thank You" hack by Abe1, which provided this mod basis structure. Our thanks and all the merit goes to Abe1.

A nice set of button and awards images have also been kindly provided by PrinceEdward to whom we also extend our thanks.

Many constructive feedbacks have been given by those members at the vB.org community who downloaded the first releases of this Mod, the implementation of which has led to an improved version of the Mod. We extend our thanks to those members.

What this mod does

It adds a "Topic Of The Week/Month" nomination system to your community.

What is Topic Of The Week/Month?

Topic of the Week/Month is a contest that select posts on which your community can commit to as a group and then comment/discuss on them during the course of the selected week/month. Any listed topic (post, thread) is eligible for the Topic of the Week/Month selection.

What determines a Topic Of The Week/Month?

Topic Of The Week/Month is based on a simple nomination system. Throughout the selected forums, members with adequate permissions can nominate their favorite topic by clicking on the award nomination button below the post.

The five topics with the most votes during the course of the week/month are automatically displayed on a nomination thread including a poll feature. At the end of the week/month, the first three topics with the most votes are the award winners of the contest.

Features:

1. Uses AJAX technology.
2. Uses one query per show thread page
3. Fully phrased to allow (language translation) (addition v 1.3)
4. Places an easy to use "Nominate Post" button next to the edit button
5. Automatically create a nomination thread for discussions on nominees
6. Displays a varying nomination stamps on posts that have been nominated for the contest. The color of the nomination stamps varies depending on how many users have nominated the post. (addition v 1.2)
7. Displays an award winner stamp op award winner posts at the end of the Topic Of The Week/Month contest. (addition v 1.2)
8. Via postbit pop-up, displays link to find all nominations or nominees made by a user (addition v 1.35)
9. Via postbit pop-up, allows selected usergroups (e.g. Moderators or SuperModerators) can withdraw all user?s nominees from all posts (addition v 1.2) or to remove all current nominations on a given user (addition v 1.35)
10. Option to select the maximum number of topics that must be displayed in the poll (addition v 1.2)
11. Option to take or not into account for nomination only posts made during the month preceding the nomination cycle time (addition v 1.2)
12. Option to consider the maximum number of posts a user can nominate per cycle time (addition v 1.2)
13. Nominated posts titles hot linked in the poll to actual thread/post of the forum. Links displaying on the same page (No. popups) (addition v 1.3)
14. Automatically closes the nomination thread at end of the contest cycle time (weekly/monthly)
15. Quick link to nomination thread via the "Quick Navigation" menu
16. Quick link to award winners page via the "Quick Navigation" menu (addition v.1.1)
17. Automatically update the nomination poll whenever a post is nominated or withdraw from the contest.
18. Separate looks for postbit and postbit_legacy
19. Places all post nominees in one small box
20. Displays award winners in one small box
21. Quick link to nomination thread via the "small box" on the thread page
22. Option to allow award winners to re-enter the contest after X days
23. Users cannot nominate the same post twice
24. Option to not allow users to nominate their own post
25. Counts nominees submitted by a user
26. Counts how many times a nominee is submitted
27. Shows how many nominees a user submitted in every post of his
28. Shows info in member's profile
29. Option to search for posts nominated by a user
30. Option to search for all nominated posts
31. Administrator can withdraw all nominees of a single post
32. Selected usergroups (e.g. Moderators or SuperModerators) can withdraw all nominees of a single post (addition v 1.10)
33. Users can withdraw their own nominee
34. Option to disable the mod on selected forums
35. Option to disable the mod on all but the first post of a thread
36. Option to disable the mod on all but the first post of a thread in specific forums
37. Option to enable/disable view of nomination date on specific or all forums
38. Option to add to post count when someone nominate a post.
39. Option to give reputation points to the user whose post is nominated.
40. Option to ban selected usergroups from using the mod
41. Option to ban selected users from using the mod
42. Option to display user?s nomination statistics on postbit (addition v 1.10)
43. Option not to display nomination statistics on postbit for selected users (addition v 1.10)
44. Option not to display nomination statistics on postbit for selected usergroups (addition v 1.50)
45. Option to display or not the hall of fame link in Quick-Links (addition v 1.3)
46. Option to select forums on which nominations must be considered (addition v 1.35)
47. Hall of fame re-designed to handle a Top 10 award winners, all time cumulated (addition v 1.3)
48. Option to refresh the poll thread if for some reason a post referenced in the poll came to be deleted (addition v 1.3)
49. Option to use the current week number or month, or the next week number or month, in the contest title (addition v 1.3)
50. Option for archiving nominations in the "Nomination Thread" automatically whenever a user nominate a post. (addition v 1.35)
51. Option to automatically send a PM to award winners at the end of the contest (addition v 1.4)
52. Option to automatically add points to award winners? reputation at the end of the contest (addition v 1.4)
53. If the current ?Nomination Thread? is deleted for whatever reason, a single manual run of the cron file will suffice to create a new thread, avoiding a clean install of the product.
54. Option to nominate blog entries (addition v 1.6)
55. Option to have award winners or nominated posts icons displayed on posts, so that nominated posts can be easily identified when listing posts.
56. Option to close current nomination thread and create a new one directly from the ACP

Installation instructions

Version 1.63

1. Uncompress the archive
2. Upload the content of the "upload" folder into your forum root directory
3. Import the "product_nominate_topic.xml" product via your ACP:
   ACP -> Plugins & Products -> Manage Product -> Add/Import Product (Allow Overwrite if you are upgrading)
4. Adjust the mod settings as you see fit.
   Specify the Forum ID that will receive nomination threads. Also specify the User ID of the nomination thread owner.
   ACP -> vBulletin Options -> vBulletin Options -> Nominate Topic Mod
5. Save the specified settings
6. ACP -> Scheduled Tasks -> Scheduled Task Manager
   Nominate Weekly Or Monthly Topic Mod -> Run Now

Enjoy

Update in version 1.01
Nominated posts titles hot linked in the poll to actual thread/post of the forum

Update in version 1.1

1. Postbit_legacy fixed
2. Quick link to award winners page via the "Quick Navigation" menu
3. Selected usergroups (e.g. Moderators or SuperModerators) can withdraw all nominees of a single post
4. Option to display user?s nomination statistics on postbit
5. Option not to display nomination statistics on postbit for selected users
6. Small bugs fixed
7. Tested on vB 3.7.0 and vB 3.7.2
8. Working on vB 3.6.8 and above

Update in version 1.2

1. Displays a varying nomination stamps on posts that have been nominated for the contest. The color of the nomination stamps varies depending on how many users have nominated the post. (addition v 1.2)
2. Displays an award winner stamp op award winner posts at the end of the Topic Of The Week/Month contest. (addition v 1.2)
3. Via postbit pop-up, displays link to find all nominations made by a user (addition v 1.2)
4. Via postbit pop-up, allows selected usergroups (e.g. Moderators or SuperModerators) can withdraw all user?s nominees from all posts (addition v 1.2)
5. Option to select the maximum number of topics that must be displayed in the poll (addition v 1.2)
6. Option to take or not into account for nomination only posts made during the month preceding the nomination cycle time (addition v 1.2)
7. Option to consider the maximum number of posts a user can nominate per cycle time (addition v 1.2)

Update in version 1.21

1. Fix for transition to Week 28 on cron file
2. Fix Unknown column error when adding a nomination.
3. Few bugs on withdraw nomination

Feedback are welcome and implementation of constructive suggestions will likely be carried out during weekends only, as I am kept busy with other matters during working days.

Update in version 1.22

1. Fix Duplicate entry issue.
2. Clean cron file
3. Full phrasing for those who wish to translate it.

Update in version 1.3

1. Nominated posts titles hot linked in the poll to actual thread/post of the forum. Links displaying on the same page (No. popups) (addition v 1.3)
2. Option to display or not the hall of fame link in Quick-Links (addition v 1.3)
3. Option to select only one forum on which nominations must be considered (addition v 1.3)
4. Hall of fame re-designed to handle a Top 10 award winners, all time cumulated (addition v 1.3)
5. Option to refresh the poll thread if for some reason a post referenced in the poll came to be deleted (addition v 1.3)
6. Option to use the current week number or month, or the next week number or month, in the contest title (addition v 1.3)
7. Fully phrased to allow language translation (addition v 1.3)
8. Cron file up-to-date

Update in version 1.35

1. Option to select forums on which nominations must be considered
2. Option for archiving nominations in the ?Nomination Thread? automatically.
3. Fortnightly cycle time added
4. Fully phrased to allow language translation (addition v 1.35)
5. Few reported bugs fixed

Update 14/07/2008 in cron file
I noticed that some code instructions fail to work properly depending on the PhP version been used.

If you are running the v 1.35 and TOTW on a weekly basis and if for some reason, your cron file failed to work and create a new nomination thread on Sunday 13, July 2008, please use the attachment "updated-cron-14-07-2008.zip". The instructions are given in there.

Update in version 1.40

1. Option to automatically send a PM to award winners at the end of the contest (addition v 1.4)
2. Option to automatically add points to award winners? reputation at the end of the contest (addition v 1.4)
3. If the current ?Nomination Thread? is deleted for whatever reason, a single manual run of the cron file will suffice to create a new thread, avoiding a clean install of the product.

Update in version 1.50

1. Option not to display nomination statistics on postbit for selected usergroups (addition v 1.50)
2. Few display titles fixed
3. Additions made for users who had problems displaying the nomination button and stamp on their styles. Checkout the "Readme and installation" file.
4. Cron file completely rewritten. Why?
   The previous cron file worked fine only when they were activated manually from the Run button in the Admin CP, but they were failing to run on their own as a scheduled task. I noticed that vbulletin global variables were no longer been passed to the cron file. Why??? I have actually getting the values of vbulletin global variables needed for the cron directly from the database.
   If you noticed that the "Nomination Thread" of the past week did not closed properly, proceed as follow:
   1. Open the cron file (upload/included/cron/
   2. Search for "// $createNewThread = 1;"
   3. Replace it by: "$createNewThread = 1;"
   4. Upload the cron file and run it manually (only once), just to close the previous thread and open a new one.
   5. Upload the original cron file back (the one with "// $createNewThread = 1;")

Update in version 1.51

1. For weekly nominations, Cron file set to create a new "Nomination Thread" every MONDAY's (00:10AM) as the week numbering starts on Monday's and not on Sunday's (as set in v 1.50)

If you are running v 1.50 with weekly cycle time and noticed that a new nomination thread has been created but the display title is still that of the previous thread (week 30), then this is for you. Do not delete the newly created nomination thread (with title week 30). On Monday 21st July, 2008, after 00:10AM, proceed as follow:

1. Refresh your poll from the ACP -> Nominate Topic -> Refresh Poll (This will update the display title of both the poll and the nomination thread)
2. Upload the content of the attachment v 1.51 to your root directory. (DO NOT MANUALLY RUN THE CRON FILE)

Topic of the Week-Month Nomination v1.51 Updated Prod and Cron

1. Automatic PM subject phrase moved from "<phrasetype name="Email Subject Text" fieldname="emailsubject">" to "<phrasetype name="GLOBAL" fieldname="global">"
2. For monthly nominations, Cron file set to create a new "Nomination Thread" every 1st day of the month (00:10AM) and not on the last day of the month.

Topic of the Week-Month Nomination v1.51 Updated function

1. Function updated (see attachment) as a result of exchanges with Kevil via TeamViewer.

Update in version 1.60

1. Option to nominate blog entries (addition v 1.6)
2. Option to have award winners or nominated posts icons displayed on posts, so that nominated posts can be easily identified when listing posts.
3. Option to close current nomination thread and create a new one directly from the ACP (NOT VIA THE CRON)

Update in version 1.61

1. Typing mistake fixed in the "nominate_topic_admin.php". nominate_topic_amount instead of nominated_topic_amount.
2. Fix for "Could not find phrase 'This is an automatic message to inform you that your post ..." message.

Update in version 1.62

1. Typing mistake fixed in the "nominate_topic_admin.php". nominate_topic_amount instead of nominated_topic_amount.
2. Fix for http:"//... occurring in the poll while listing blog entries.
3. Display of nomination stamps while listing blog entries from the blog.
4. Fix for displaying of blog entries in poll when a post is nominated from the non blog board.

Update in version 1.621

1. Fixed "Parse error: syntax error, unexpected '}' in /includes/cron/nominate_topic_cron.php on line 584"
2. Fixed ": syntax error, unexpected T_STRING in /home/nascartr/public_html/community/admincp/nominate_topic_admin.php on line 435"

Update in version 1.63

1. Fixed link call, requested by TsirhCitna
2. Fixed "Hall of fame" display.

Update in version 1.635

1. Bug Fix by vbboarder implemented ? ?can?t find phrase? error in PM subject

Update in version 1.636

1. Default value for "cycle time header" set to use the current cycle time (current week/fortnight/month instead of next week/fortnight)
2. Option to nominate own post activated by default.

Feedback are welcome and implementation of constructive suggestions will likely be carried out during weekends only, as I am kept busy with other matters during working days. Also, feel free to add improvements in those files and post them.

To other coders: feel free to add improvements to the Mod (files) and post them. I will directly use your updated files for the next version of the mod.

[Nikke]

Great mod!

I have one problem though. I've set it for a weekly thread, but the title of the thread is still Thread of the week - July - 2008. How do I get it to show the current week?

[goranbaxy]

Originally Posted by J98680B2423E

If you are having trouble with the nominate button and stamp images not displaying, proceed as follow:

1. ACP -> Templates & Styles -> Search in Templates
2. Search for “postbit”
3. Open the “postbit” for customization (for edit)
4. Search for:

<td valign="top" nowrap="nowrap">
				<div class="smallfont">
					<if condition="$post['joindate']">

5. Add before it:

$nominate_topic_stamps_box

6. Search for:

$template_hook[postbit_controls]

7. Add after it:

$nominate_topic_button

8. Open the “postbit_legacy” for customization (for edit)
9. Search for:

<!-- / icon and title -->

10. Add after it:

$nominate_topic_stamps_box

11. Open the product file “product-nominate_topic.xml” using for example WordPad
12. Search for the following text (there are 2 occurrences of it):
// If you are having trouble with the nominate button…
13. Follow the instructions.

I did that and still nothing, VB is not even generating code for button

[J98680Bxxxxx]

Originally Posted by Nikke

Great mod!

I have one problem though. I've set it for a weekly thread, but the title of the thread is still Thread of the week - July - 2008. How do I get it to show the current week?

A screenshot will help. Please add one showing the displayed title.

Originally Posted by goranbaxy

I did that and still nothing, VB is not even generating code for button

Do you have the button displayed when using the default vbulletin style? Let me know.

[goranbaxy]

On a default style it works normally

[J98680Bxxxxx]

Originally Posted by goranbaxy

On a default style it works normally

I have noticed with another user that a "customized style" can have an effect on some functions calls, namely these ones:

$this->registry->userinfo
defined('LOCATION_BYPASS')
nominate_topic_off($thread['forumid'], $post, $thread['firstpostid'], THIS_SCRIPT)

They all return false some how on some "customized styles", hence the non display of the nomination button and stamps since they are activated by successful completion of the test:

					if ($this->registry->userinfo['userid'] != 0 && !(defined('LOCATION_BYPASS')) && !(nominate_topic_off($thread['forumid'], $post, $thread['firstpostid'], THIS_SCRIPT))){...}

I have installed one of those "customized" styles on my test site and I have the nomination button displaying properly. I am still trying to figure out why it does not display on other users sites. Any suggestions are welcome.

[Covert-OPs_]

Originally Posted by J98680B2423E

QUOTE=Covert-OPs_;1580282]Any news on fixing the issue with the vote button that is not displaying properly?

If you are having trouble with the nominate button and stamp images not displaying, proceed as follow:

1. ACP -> Templates & Styles -> Search in Templates
2. Search for ?postbit?
3. Open the ?postbit? for customization (for edit)
4. Search for:

<td valign="top" nowrap="nowrap">
				<div class="smallfont">
					<if condition="$post['joindate']">

5. Add before it:

$nominate_topic_stamps_box

6. Search for:

$template_hook[postbit_controls]

7. Add after it:

$nominate_topic_button

8. Open the ?postbit_legacy? for customization (for edit)
9. Search for:

<!-- / icon and title -->

10. Add after it:

$nominate_topic_stamps_box

11. Open the product file ?product-nominate_topic.xml? using for example WordPad
12. Search for the following text (there are 2 occurrences of it):
// If you are having trouble with the nominate button?
13. Follow the instructions.




We can take a look together if you wish. Send me a TeamViewer session invitation letting me know when you will be online.[/QUOTE]

But I thought we did all this together on teamviewer already?

[J98680Bxxxxx]

Originally Posted by Covert-OPs_

If you are having trouble with the nominate button and stamp images not displaying, proceed as follow:

1. ACP -> Templates & Styles -> Search in Templates
2. Search for ?postbit?
3. Open the ?postbit? for customization (for edit)
4. Search for:

<td valign="top" nowrap="nowrap">
				<div class="smallfont">
					<if condition="$post['joindate']">

5. Add before it:

$nominate_topic_stamps_box

6. Search for:

$template_hook[postbit_controls]

7. Add after it:

$nominate_topic_button

8. Open the ?postbit_legacy? for customization (for edit)
9. Search for:

<!-- / icon and title -->

10. Add after it:

$nominate_topic_stamps_box

11. Open the product file ?product-nominate_topic.xml? using for example WordPad
12. Search for the following text (there are 2 occurrences of it):
// If you are having trouble with the nominate button?
13. Follow the instructions.




We can take a look together if you wish. Send me a TeamViewer session invitation letting me know when you will be online.

But I thought we did all this together on teamviewer already?[/QUOTE]

We tried different options (changing template hooks, testing input/output parameters), but we didn't tried to place the "nominate button" and the "nominate stamp" templates manually in your postbit/postbit_legacy templates. Hence I added the text above in the readme file after having tested it on my test server.

[SSJB_7]

when i installed it and tried to open an existing post an error come up....

can i do anything to correct it?

[Raptor]

i hope this mod works correctly sometime soon

after half a dozen "fixes" a new thread is still not created - it keeps on using the same thread for each week - surely the last weeks should be closed and then a new thread started. its very confusing for members when its the same thread used each time.

vb 3.7.2

TOTW v1.5.1

[MissKalunji]

Originally Posted by J98680B2423E

I have noticed with another user that a "customized style" can have an effect on some functions calls, namely these ones:

$this->registry->userinfo
defined('LOCATION_BYPASS')
nominate_topic_off($thread['forumid'], $post, $thread['firstpostid'], THIS_SCRIPT)

They all return false some how on some "customized styles", hence the non display of the nomination button and stamps since they are activated by successful completion of the test:

					if ($this->registry->userinfo['userid'] != 0 && !(defined('LOCATION_BYPASS')) && !(nominate_topic_off($thread['forumid'], $post, $thread['firstpostid'], THIS_SCRIPT))){...}

I have installed one of those "customized" styles on my test site and I have the nomination button displaying properly. I am still trying to figure out why it does not display on other users sites. Any suggestions are welcome.

well ic ould be wrong

But i did notice that some of my buttons wasn't working mainly because it was missing some of the standard Hooks from default vbulletin installation example : $template_hook[postbit]
and $template_hook[postbit_controls] without those two the buttons wouldn't show

So if im right you wrote your code to search for this line then to add it which could explain why SOME style doesn't work cause some people remove it thinking it's not useful etc. Once i added it everything showed up.

I could be wrong for the nominated ribbon but that was my case for the nomination button

Hope that can help you.