Posting/PM Word Count

[Chris]

OK, version 1.0.4 has been submitted for online library approval and as discussed it now exposes a few properties and methods that might be useful to other plugins:

window.eton = {
	"eton_word_count" : {
		
		/* 
		 *	currently active counting mode (words or characters) 
		 */
		 
		"mode" : "words", 
		
		/* 
		 *	reference to the WYSIWYG object created by Proboards 
		 *	or created for quick reply by the plugin
		 */
		 
		"wysiwyg" : [Object object],
		
		/* 
		 *	 character count
		 */
		 
		"last_length_count" : 16,
		
		/* 
		 *	 word count
		 */
		 
		"last_word_count" : 2,
		
		/* 
		 *	 list of limits considered for this page, a limit is defined in plugin settings and can be scoped to the entire forum, categories, boards or threads. Threads are the most powerful and will override any other limit in effect.
		 *	 Limit Precedence (strongest to weakest): Threads >> Boards >> Categories >> Forum
		 */
		 
		"limits" : {
			"forum" : {
				"limit" : "2999999",
				"limit_type" : "min_length",
				"exclude_members" : [],
				"exclude_groups" : []
			}
		},
		
		
		/* 
		 *	limit determined to apply to this particular page and user
		 *	(example below is a forum limit set to 2,999,999 minimum words effectively preventing any posting given the max length of a post is 2^18 )
		 */
		 
		"effective_limit" : { 
			"name" : "Forum Name",
			"source" : "forum",
			"id" : 0,
			"limit" : "2999999",
			"mode" : "words",
			"type" : "min_length" //min_length, max_length, min_char_length, max_char_length
		},
		
		
		/* 
		 *	The validation object used to enforce the effective limit
		 */
		
		"validation" : {
			"name" : "message_word_length",
			"field" : "message",
			"opts" : {
				"area_of_effect" : ".ui-wysiwyg .editors",
				"min_length" : "2999999"
			},
			"message" : "Your words count is below the limit of 2999999 words set for this forum"
		},
		
		
		/* 
		 *	plugin settings
		 */
		 
		"settings" : {
			"default_mode" : "words",
			"no_limit_no_show" : "noshow",
			"paste_html" : "paste",
			"put_count_in_post" : "postcount",
			"alternative_target_id" : "",
			"limit_type" : "min_length",
			"limit_threshold" : "2999999",
			"limit_staff" : "staff",
			"exempt_members" : [],
			"exempt_groups" : [],
			"limit_threads" : [{
					"thread" : "15",
					"limit_type" : "min_length",
					"limit" : "750",
					"exclude_members" : [],
					"exclude_groups" : []
				}, {
					"thread" : "37",
					"limit_type" : "min_length",
					"limit" : "1",
					"exclude_members" : [],
					"exclude_groups" : []
				}, {
					"thread" : "14",
					"limit_type" : "none",
					"limit" : "0",
					"exclude_members" : [],
					"exclude_groups" : []
				}, {
					"thread" : "36",
					"limit_type" : "min_length",
					"limit" : "-3",
					"exclude_members" : [],
					"exclude_groups" : []
				}, {
					"thread" : "29",
					"limit_type" : "max_char_length",
					"limit" : "11",
					"exclude_members" : [],
					"exclude_groups" : []
				}
			],
			"limit_boards" : [{
					"board" : [
						"9"
					],
					"limit_type" : "none",
					"limit" : "",
					"exclude_members" : [],
					"exclude_groups" : []
				}, {
					"board" : [
						"3",
						"1"
					],
					"limit_type" : "min_length",
					"limit" : "5",
					"exclude_members" : [],
					"exclude_groups" : []
				}
			],
			"limit_categories" : [],
			"enable_enhanced" : [
				"enhance"
			],
			"enable_monetary" : "monetary",
			"money_mode" : "proportional",
			"word_up" : [{
					"min_words" : "9",
					"money" : "-20.00"
				}
			],
			"ignores" : [{
					"bbcode" : "quote",
					"html" : "div.quote"
				}, {
					"bbcode" : "code",
					"html" : "code"
				}, {
					"bbcode" : "img",
					"html" : "img"
				}
			],
			"word_regex" : "",
			"post_pattern" : "/(%[wc]c#[-+\\d]*)/gi",
			"bbcode_max" : "",
			"enable_debugging" : [
				"debug",
				"debug_limits",
				"debug_plugins"
			]
		},
		
		/**
		* Method: getAutoformByField
		*
		* Searches an autoForm array and returns match(es) based on the specified field
		*
		* Parameters:
		* AUTOFORMARRAY - *array* an array of plain javascript objects
		* FIELD - *string* The name of the field in each object that should be searched
		* VALUE - *string* OPTIONAL value used to compare against the field, if omitted then all entries possessing the specified field will be returned (existence)
		* MULTIPLE - *boolean* OPTIONAL a flag indicating whether to return an array of ALL found (if set to true) or return only the first object found (if set to false/undefined)
		*
		* Returns:
		* *object* / *array* / *undefined*
		*/
		
		"getAutoformByField" : function (autoformArray, field, value, multiple),
		
		
		
		/**
		* Method: getEditorText
		*
		* Determines the active editor (bbcode or visual) then preprocesses the text before returning
		* HTML and BBCODE tags (that are recognized) are removed as part of the preprocessing
		* Special tags (defined in plugin settings) such as QUOTE and CODE will also have their contents removed so they can be ignored while counting
		*
		* Returns:
		* *string* - the normalized text pulled from the current editor
		*/
		
		"getEditorText" : function ()
	}
}

[Chris]

With Sphinx temporarily out of commission I've been  using alternate searches and surprisingly these yielded results that the Sphinx knew not (I hope the team finally solves the riddle of the Sphinx). One issue returned by the alternate search that stood out, but was never reported to me, were forums running multiple copies of the word count plugin ( this will cause problems creating and editing posts ). Until a fix is in place, it is recommended that you do not run multiple instances of the plugin. A fix will be pushed out for this as soon as possible!

[Chris]

version 1.0.5 submitted to online library

- added multiple instances detection algorithm so plugin knows if multiple versions of itself is running at any given time, ensuring that there can be only one (aka the Highlander Patch)
- stop including line feeds and carriage returns in character count mode

---

It was recently brought to my attention that the counter remains at zero for some people when typing. If you're one of these people I would love it if I could pick your brain to get to the bottom of this since I have yet to encounter a bug of this nature.

[e105beta]

Hey,

We've just implemented your Word Counter over on our forum as a way to only reward money to those who reach a certain word count in their posts, specifically 20 gold for anything past 250 words.

For me I'd say it works about 90% of the time, but there are times when money is not being incremented for a seemingly indiscernible reason, and for some users it works very rarely. I understand there is an issue where mobile users cannot use plugins unless they use the Desktop version of the site, but that doesn't seem to be the case here. The odd thing is that the users for which the plugin seemingly malfunctions were able to use the base monetary system just fine.

Would you be able to provide any insight as to what may be happening? I've currently disabled the bonus and returned to the Monetary Plugin because it was becoming unmanageable to keep updating people's gold.

Here's a link to our board if it helps: fewotw.proboards.com/

[Emerald]

Hmm. I seem to be having an issue. The word counter thing has appeared in the bottom-right of the post, but it stays at 0 and doesn't go up. I have tried clearing my cache and cookies, in fact this started happening after I had cleared my cache and cookies, so it can't be that.

Any ideas? Tell me if you need more information on something, because this is really helpful.

Edit: Just read the above. Pick my brain please.

[Chris]

Jan 2, 2015 10:22:22 GMT -8 Emerald said:

Hmm. I seem to be having an issue. The word counter thing has appeared in the bottom-right of the post, but it stays at 0 and doesn't go up. I have tried clearing my cache and cookies, in fact this started happening after I had cleared my cache and cookies, so it can't be that.

Any ideas? Tell me if you need more information on something, because this is really helpful.

Edit: Just read the above. Pick my brain please.

Thank you for responding Emerald, my initial inspection of your forum yielded no golden goose just yet.
I'm seeing no set limits in the plugin but I did a test post in Firefox and chrome switching between preview and bbcode multiple times to see if that would recreate the situation you've described.

SPOILER: Click to show

{
"default_mode" : "words",
"paste_html" : "paste",
"alternative_target_id" : "",
"limit_type" : "min_length",
"limit_threshold" : "",
"exempt_members" : [],
"exempt_groups" : [],
"limit_threads" : [],
"limit_boards" : [],
"limit_categories" : [],
"enable_enhanced" : [],
"enable_monetary" : "monetary",
"money_mode" : "bonus",
"word_up" : [],
"ignores" : [{
"bbcode" : "quote",
"html" : "div.quote"
}, {
"bbcode" : "code",
"html" : "code"
}, {
"bbcode" : "img",
"html" : "img"
}
],
"word_regex" : " /\\b[\\w\\-']+\\b/g",
"post_pattern" : "/(%[wc]c#[-+\\d]*)/gi",
"bbcode_max" : "300",
"enable_debugging" : []
}



If this is occurring in a specific category, board or thread then knowing that would certainly help.
If this is occurring on a certain theme and not another then that would certainly help.
If you are using a different browser then please say which one and the version.
If this is occurring for staff but not normal members (or guests) then that would narrow it down
If this is occurring when you are pasting content as opposed to typing it then that would also narrow it down.
Anything else you can think of (some step I might be missing) to help me reproduce this would be appreciated.

[Emerald]

Chris, the problem seemed to clear after switching accounts. I'm using the latest Chrome on a Windows 7. And when the problem did occur, it was on all boards on the main admin account. That's all the information I could provide, since like I said, it cleared after switching forum accounts.

[rileyrykov]

Hey Chris
I've had some issues with this plugin today. There have been a few occasions when posts haven't worked properly, most apparent when guests have posted adverts, but also when one of the admins made posts. The thing in common between them is the firefox browser. We were advised to try without plugins, and then we slowly added them back in one at a time to see if they would start working again. They worked until Word Counter was turned back on, and then messed up again, but worked fine again once it was disabled again. I have no idea why this was happening but it only seemed to affect some Firefox users.
Just making you aware that this happened!

[Chris]

The Word Count plugin makes no modifications to post contents just counts them. The symptoms you describe in your support board thread however does fall in line with symptoms similarly described for other firefox users and attributed to the style tags plugin which does indeed modify post contents on a massive scale.

Oct 31, 2014 13:38:54 GMT -8 CheatAreZee said:

I was able to re-create the issue there, however, with the Style Tag plugin disabled it seemed to correct the issue in Firefox. Not sure why that plugin specifically affects it, but that looks to be the cause at least.

[rileyrykov]

There were a lot of similarities with style tags issues yet things posted normally with style tags on or off, but stopped working when word count was enabled, though it was the last plugin I'd have expected to be causing it. We went through and tested every plugin one at a time to see where the problem was coming from.

[vipoi]

Chris, thank you for the brilliant plugin.

I need some big help from anyone who has the answer -- is there any way to modify this plugin so while working in tandem with Monetary System instead of a Bonus per WC I can multiply a number against the WC and deliver that product to the poster's wallet automatically?

For example:

Someone writes a WC of 1000. I want to be able to apply a .7 (as an example) to that 1000, and get 700. It would also need to be able to apply other percentages to the WC and arrive at a product.

Is that at all possible?

[Chris]

The monetary feature allows for "bonus" mode or "proportional" mode (also referred to as "prorated"). The proportional mode is based on the highest created word count rank and what percentage of that high watermark the poster actually achieved. For example, if they posted 1200 words and the highest word count rank created in the plugin's settings is 3200 then they would get 37.5% of the total money that would have normally been awarded by the monetary system.

Perhaps I am misunderstanding what you're asking here but it sounds like (from your example) you want to award 700 for a 1000 word count which can be accomplished by setting up a word count rank of 1000 words and giving it a payout of 700 in bonus mode. You can set different ranks (200, 500, 700, 1200, etc) with differing payouts per word count rank achieved. In propo mode, if you've imposed a minimum word count amount for that particular post then that would first need to be met before proportional mode kicked in. Using the same example, a 1000 word post with a 400 word minimum would mean the post would be treated as if the poster only wrote 600 words (1000 minus 400) when calculating proportional payout. Since you can set minimums based on groups or individual members then this means you could define a minimum for one group and a different minimum for another group thus directly affecting the the effective rate on a per group or per member basis.

Perhaps if you describe the source of this 0.7 number or whatever proportion you wish to use then it might become a bit more clear to me.

[vipoi]

Chris, thanks so much for your prompt response!

I may be able to do something with the method you describe, but I will try to explain why I would like to be able to apply a product.

I am staff in a writing/RP game that is growing too large for our volunteer graders to handle in a timely fashion. Based on a player's writing, we assign a quality score to that player which changes as their writing develops, and we apply this score to their Word Count in each post and add the score into their miniprofile. They progress through the game based on this product of Quality x Word Count.

Because of this system where each player gets a unique quality score, and because there are certain equipped items that also involve this score, I would like to be able to somehow assign this number to either an individual profile or to a group and have it multiplied against their WC automatically.

Something like that would be the holy grail. I will test your method and see if there is some way we could change our system to suit it, but if you have any further insights I'd really appreciate.

[gtv22]

Hi Chris
I am having difficulty getting the 'Words' to line up on my posting pages. I would like it to be higher up so it clears the top of the bottom box line.

Would you please help me?
Thanks

[Chris]

Oct 9, 2015 13:02:29 GMT -8 gtv22 said:

Hi Chris
I am having difficulty getting the 'Words' to line up on my posting pages. I would like it to be higher up so it clears the green box line.



Would you please help me?
Thanks

Hi gtv22, this should place the 'Words' inside the counter...

Jul 27, 2014 11:06:17 GMT -8 Brian said:

Hi, lisilahlah.

Add this to your forum's global header.

<style type="text/css">
.word-count.mode-word .status:after { content: " Words"; }
.word-count.mode-char .status:after { content: " Characters"; }
.word-count .icon:after { content: none !important; }
</style>