AutoReviewComments - Pro-forma comments for SE

Question

No more re-typing the same comments over and over!

This script adds a little 'auto' link next to all comments boxes. When you click the link, you see a popup with 6 configurable auto-comments, which you can easily click to insert.

This script was inspired by answers to this question on meta.

Features

1. Read your comment before you post it!

Note that the dialog only inserts the text, it doesn't send the comment, nor does it flag anything; this is so that you can check the text before posting!

2. Customize the texts

Simply double click on a comment text or description in order to customize it. Hit the 'reset' button if you screw up. This customization is currently per-site. Note that the "Welcome to $SITENAME$" text is automagically inserted if the user is 'new' (member for less than a week), so you don't need to add that to your custom text (but you can if you want to, see '9' below).

If you need more/less than the default 6 comments, just carry on reading...

3. Quick user info

The dialog also includes a mini-summary of the user's activity (because if they haven't been back in months, there's no point writing them a comment).

4. Automatic notification of new versions

The script will also notify you if a newer version is created.

5. Import/export of custom comments

This helps with transferring custom comments between sites. The export/import 'format' is also conveniently presented as markdown, so you can post it in an answer below, and let others benefit from your words of wisdom.

Note that you can also use the Import to create an arbitrary number of comments (the default is 6). If there are too many, you can use the show/hide desc link to gain a bit of space.

6. Remote source for comments

If you get bored with copy/pasting your comments between sites and/or computers, you can use the 'remote' button to define a remote source for your comment texts. See here for more details.

7. Differentiated comments for questions/answers

If you prefix your comment title with [Q], it will be only displayed for questions ([A] for answers). Non-prefixed comments are displayed for both.

8. [type here], [username] & [OP]

If the text [type here] is included in a comment, it will be automatically selected for completion when inserted. [username] will be replaced with the user's name (or just 'user' if nothing was found), and [OP] with the original poster's name (if found, else 'OP').

9. Customise welcome message

The default message is "Welcome to $SITENAME$" - which is shown for any 1-week-old users. By clicking on the 'welcome' link at the bottom of the popup, you can opt to change this message, or leave it empty to show no messages at all. You can also 'force' the message for older users on a one-off basis. This is per-site.

Installation

Click HERE to install the user script. (warning Google are making things difficult for non-store user scripts. A workaround is explained here. Or use a script manager, like tampermonkey. For other browser-specific instructions, read the instructions here)

Click HERE to preview the code.

For more information about user scripts, check out the script tag wiki here.

Update info

(See comments and answers below for details)

V1.2.8 - Update to take advantage of new 'draggable dialogue' functionality.

V1.2.7 - Correct bug noted by Oddthinking, and implement the 'force welcome' function requested by Martin Scharrer.

V1.2.6 - Implement the much-requested override for the new user Welcome message. Correct a bug with mangled markdown and another due to modified SE markup.

V1.2.5 - Implement [OP] tag as suggested by Gaffi. 'Fix' for markdown/html conversion bug reported by Madara Uchiha.

V1.2.4 - Modify code to get script working in new Review (reported by Oliver Salzburg), hat-tip to Shog9 for the fix.

V1.2.3 - Slight modification to remote dialogue (details here). You can now use [username] as a wildcard (as suggested by daviesgeek). Corrected & bug noted by Oliver Salzburg

V1.2.2 - Remote comment sources. Broadcasts. Read the details here.

V1.2.1 - update to work with 10k tools (suggested/implemented by ThiefMaster)

V1.2.0 - one fix (remove greeting before switching to edit mode), and one feature: hit Enter key to submit (suggested by Bruno Pereira). Note that this isn't a major change, it's just my version comparison is string-wise, so V1.1.10 won't work.

V1.1.9 - fixed nasty javascript regex backreference replace bug (reported by ThiefMaster). For explanations see here and here.

V1.1.8 - fixed 'jQuery 1.7.1' bug, which stopped insert button being enabled. (No idea why it stopped working - though judging from this, maybe it should never have worked, as I was using attr("disabled", ""))

V1.1.7 - create pseudo categories for differentiating between comments for questions and comments for answers (suggested by oers) - simply prefix the comment title with [Q] or [A]

V1.1.6 - make script work in /admin/dashboard (for moderators, requested/implemented by Sathya)

V1.1.5 - make script work in /review (requested by Gilles (now uses jquery delegate for attaching events)

V1.1.4 - if the text [type here] is included in a comment, it will be automatically selected for completion (requested by daviesgeek)

V1.1.3 - include Registered/Unregistered in user info (requested by waiwai933).

V1.1.2 - Fixed bug when using 'magic' links (reported by Alex)

V1.1.1 - If you have descriptions auto-hidden, the selected one will still be shown (suggested by Alex).

V1.1.0 - bug fix. (SE's full.js is now delayed at load, so the unbind('click') was undoing my click() - fix from @balpha).

V1.0.9 -
- a) removed upgrading bits from previous version
- b) added internal notification feature
- c) now uses internal notification for announcing new versions - d) corrected the 'new versions announced once only' (it never worked AFAICT)
- e) corrected the $SITEURL$ escaping 'quirk'
- f) stopped using .owner class for userinfo - g) corrected bug which showed greeting twice.

V1.0.8 -
- a) Mend see-through code.
- b) Make storage more neighbour-friendly (add prefix, backwards compatible).
- c) Allow variable number of custom comments (can only be modified via import).
- d) Add show/hide description functionality. Add vertical scrollbars if too many comments.
- e) Use 'selfupdatingscript' for update checks
- f) Revert $SITEURL$ to not contain the http://.

V1.0.7 - add an import/export function - can be used to transport custom comments between sites (note the use of $SITEURL$ and $SITENAME$ tags),

V1.0.6 - changes to the list of included urls

V1.0.5 - suppress warnings on new updates if already installed (previously each site would tell you about a new update, even if you'd already installed it)

V1.0.4 - corrected two bugs in code detecting the appropriate userid to lookup

V1.0.3 - corrected a bug in rep formatting. Integrated a function to poll once a day for new versions and notify user if any found.

V1.0.2 - implemented customisation, using HTML5 storage to allow users to create/modify their own messages

V1.0.1 - some refactoring, corrected a bug in the regex that converted html to markup.

Note

Any comments welcome, whether on the functionality or the code.

Can be used in tandem with my other user script.

Credits

• TomWij (below) created a modified version of the script, which inspired my V1.0.8
• balpha came up with the clever (evil) way to make the script 'self-updating'
• All the people who made suggestions in the comments and answers below!

Known issues/Future plans

• Currently thinking about how to make the Welcome message configurable (i.e, how to present the configuration in the interface without creating extra clutter)
• The main future plan is to get this script adopted by SE. I like maintaining it, but some of the usability niggles (sharing across sites is still clunky, even with the remote option) can only be resolved centrally. (Vote here if you agree!)
• The new 'service announcement' functionality has a major 'bug' - you have to dismiss it manually on every single site. Sorry!

Answer 1

status-completed

Feedback:

The definitions of the sites are not all-inclusive. For instance, the link doesn't show up on stackapps ;)

Answer 2

Future ideas: use HTML5 storage to allow users to create/modify their own messages.

status-completed

• double click on a title or description to modify
• save/cancel
• 'reset' link at bottom of popup (not shown above) resets all custom messages to default

Important

• The 'Welcome to SiteName!' text is prepended automatically if the user has been member for less than a week.
• This uses HTML5 Storage, so custom texts only work on the site where they were entered.

NOTE

With this modification, there is no longer any reason that this userscript should be strictly limited to 'review'.

Answer 3

Future idea: include an 'auto-update' function which polls for new versions and notifies user (with anti-nagging functionality).

status-completed

Answer 4

Another future idea: expandable groups of comments similar to the way Close>Off-Topic opens a list of sites.

status-completed

Answer 5

I'll drop my setup here.

###Comment as answer
__This is not a forum. Please only use the 'Post Your Answer' button if you can answer the asker's question; <a href="http://gaming.stackexchange.com/privileges/comment">post a comment</a> otherwise.__ We require some <a href="http://gaming.stackexchange.com/faq#reputation">reputation</a> before you can comment others' posts to prevent abuse; why don't you try and get some by <a href="http://gaming.stackexchange.com/unanswered">answering a question?</a>

###Question as answer
__This is not a forum. If you have a different question from the asker's, please use the <a href="http://gaming.stackexchange.com/questions/ask">Ask Question</a> button__ instead. You don't even have to login!

###Upvote as Answer
__This is not a forum. If you wish to thank somebody, you should <a href="http://gaming.stackexchange.com/privileges/vote-up">vote him up</a>.__ We require a little bit of <a href="http://gaming.stackexchange.com/faq#reputation">reputation</a> before you can do that to prevent abuse; why don't you get some by <a href="http://gaming.stackexchange.com/unanswered">answering a question?</a>

###Not a Real Question
This is not a forum; __this is a questions and answer site, and I'm afraid your post isn't really a question, because <a href="http://blog.stackoverflow.com/2011/01/real-questions-have-answers/">real questions have answers, not items or ideas or opinions</a>.__ <a href="http://gaming.stackexchange.com/faq">Please read the FAQ for more information.</a>

Answer 6

status-declined

@Benjol You could add the extra set of comments that I use in-tandem with Phrase Express:

---

@<username> Please don’t use signatures or taglines in your posts. Every post you make is already "signed" with your standard user card, which links directly back to your user page

---

Shopping questions are off-topic as per the FAQ: it is not about a shopping or buying recommendation

---

Answer 7

status-completed

Doesn't work on superuser.com (only www.superuser.com) because it includes only domains with a period like so:

http://*.superuser.com

and should be

http://*superuser.com

Answer 8

I felt limited by only six comments, so I made some small improvements.

Implemented the following features:

_{Head list items are intended for users, sub list items are intended for developers.}

• Allow the user to enter an unlimited amount of comments. (Add them in import/export)

  • Based the script on the local storage, while using comments only for initial data or to reset.
  • Refactored duplicate code & checks as comments behavior is replaced by localStorage.
     

• Scrollbar for when the amount of comments exceeds the standard height.

• Added a link to allow the user to toggle the visibility of descriptions.

  • This is remembered by using the local storage.
     

• Improved see-through behavior by hiding title and buttons and making it more transparent.

• Fixed invalid info: "User info detection doesn't work on CW answers, nor with deleted users."

  The box now either shows "This user is not registered." or hides.

• Fixed greeting consistency, it's now added again after editing comments.

Old version:

Please make sure that both versions do not conflict.

Download Old Version | Source

This has been implemented by Benjol!

status-completed

Answer 9

Somehow, it doesn't show the "auto" link any more here... re-installed already. FF 4.0.1 using latest version of Greasemonkey.

status-completed

Answer 10

status-declined

It might be really nice if this could come pre-loaded with a in a few comments by default that will be global to all sites. There are already a couple good examples here.

Another useful one would be something about the accept rate.

Your accept rate is currently low, please review your existing questions. Please respond to any comments, please update to add more detail if possible, If there is correct answer, please accept, if any of the existing answers don't work please add a comment explaining why.

Answer 11

status-completed

Can comment text please be collapsed/hidden by default and only expanded for the currently chosen option? This would work kind of like the 'more info' link in the faq which pops out when you click it. (My dialog is getting pretty big now and this would really help!)

As already said by many others - thank you so much for this script!!

Answer 12

status-completed

There appears to be a bug with the [edit] magic link.

Using this text:

Question needs more information

We need more information to answer your question. Please [edit] your post and add details as requested by the community. It will be closed for now, but don't worry - once you have improved the question flag a moderator and it can be reopened. See How do I ask questions here? for general guidelines.

Gives a broken preview:

The comment still inserts OK however.

Answer 13

status-completed

Since you're fetching user info from the userpage, could you add in something to show whether the user is registered or not?

Answer 14

status-declined

Can you add multiple pages of comments? Currently if you have a lot of auto comments, you have to scroll to see them, but it would be nice to be able to click next and previous to see lists of about 5 comments.

Also, the "see through" feature is cool, but it should be activated by a click, instead of on mouse over.

One more problem: Importing the comments seems not to save them.

Answer 15

status-completed

In GreaseMonkey the Name of the Script is AutoReviewComments but the name of the StackApp is Pro-Forma comments.

This makes it very hard to find the app (once you forgot its name :D).

Maybe those could be named equally?

Answer 16

status-completed

Small bug: I haven't figured out at which point this happens exactly, but the script seems to be over-enthusiastic adding the "Welcome" prefix:

Welcome to $SITENAME$! Welcome to $SITENAME$! Welcome to $SITENAME$! The code you show is vulnerable to SQL injection. Use the proper sanitation method of your library (like mysql_real_escape_string() for the classic mysql library), or switch to PDO and prepared statements.

Unless you already know what causes this, I'll keep an eye on it and report back.

Answer 17

status-completed

Could you add classifications/grouping for comments?

I'd like to group my comments into

1. comments for question
2. comments for answers
3. Both

And only the relevant comments will show, when I click the auto-link.

Answer 18

Here's an addition to the stock comments which I've found useful:

###Request for action on copyright violation
We don't have the authority to judge whether or not this constitutes a copyright
violation. All copyright violations should be reported to Stack Exchange, Inc. 
in the form of a DMCA takedown notice from a copyright holder per 
<a href="http://stackexchange.com/legal">site policy</a>.

Substitute 'users', 'moderators', or something else for 'We' if you like.

See also What should I do when I see copyright violations posted on Stack Overflow? and Should moderators enforce NDAs for software vendors?

The relevant section in /legal is section 15, I've requested deep links on that page here.

Answer 19

status-completed

Is it possible that you could save the comments in a file so that when the script is updated I don't lose my custom comments?

Answer 20

status-thinking-about-it

It would be great to be able to use this same functionality in the edit summary when making edits. Most of the edits I do fall into a small subset of "categories" and it pains me to have to put in the same summary over and over.

Adding a category (much like already exists for question-only or answer-only comments) would be a big help beyond just adding the "auto" link next to the edit summary input box.

To take it one step more, since edits may be for more than one thing at a time, a slightly different interface that is checkbox-based, rather than radio buttons would be ideal so that I could combine / chain the edits I've made.

In summary, here's what I am asking for (in order of priority / usefulness):

1. Adding the dialog link to the Edit Summary input
2. Adding a category for Edit Summaries
3. Changing the behavior for edit summaries to allow for adding multiple "comments"

Answer 21

status-completed

The following message breaks the script, apparently due to the $ in backticks:

###jQuery-$
Did you know that you only have to write `jQuery` in its long form once? By wrapping your code in `(function($) { .... })(jQuery);`, you can use `$` no matter if `noConflict` has been used or not.

Answer 22

status-completed

Can $SITENAME$ be changed for Christianity? Here's what a comment to a new user reads:

Welcome to Christianity! ...

Which sounds pretty creepy. For one thing, most folks who stumble into the site are already affiliated with some faith, which might or might not be Christianity. For another, it sounds like we are a cult or a church. We aren't.

Could $SITENAME$ be changed to "Christianity—Stack Exchange" or "Christianity.SE"?

(I haven't tried to adjust the messages myself, but besides being a bit tedious, it probably would be best to not have new users of the script sending the wrong signals.)

It's less of a concern, but I think it would be odd to see messages like:

Welcome to English! ...

or

Welcome to Parenting! ...

---

I forked a version and made the following changes at line 67:

if(sitename == "Stack Exchange"){
  sitename = arr[arr.length - 2]; //workaround for SE sites..
  greeting = 'Welcome to ' + sitename + '—Stack Exchange! ';
  sitename = sitename + '.SE';
}

That way, the "Answers just to say Thanks!" comment reads:

Welcome to Christianity—Stack Exchange! Please don't add "thanks" as answers. Invest some time in the site and you will gain sufficient privileges to upvote answers you like, which is the Christianity.SE way of saying thank you.

The same comment on SO reads:

Welcome to Stack Overflow! Please don't add "thanks" as answers. Invest some time in the site and you will gain sufficient privileges to upvote answers you like, which is the Stack Overflow way of saying thank you.

Answer 23

status-completed (You can now override this if you don't like it)

Another bug: Every comment is prefixed with "Welcome to StackOverflow!" since recently. Doesn't seem to happen on all pages; http://stackoverflow.com/questions/9729546/jquery-script-being-executed-before-all-each-has-completed is one where it does happen though.

Answer 24

status-completed

The same way we press Esc to close the list can we have Enter to add the comment directly instead of the button bellow the list?

My list is getting a bit big and every time I need to select a comment (in a small laptop screen mind you) I need to scroll to the comment, click, scroll down to the end, click to add the comment and the scroll back up on the page to where I was before.

Can this be fixed so Enter adds the comment directly without needing to scroll all the way down?

Answer 25

status-completed

Can you also add the auto link on the flag review page of 10k+ users? Especially when going through the "not an answer" flags there are tons of "thanks" and "question instead of answer" posts.

Update: To get it working, there are only minor changes needed:

• Enable the script for /tools* on the various sites

• Add .mod-post-header to the delegate list for the click event:

  $(".question, .answer, #questions, .flag-container, .mod-post-header").delegate(".comments-link", "click", function () {
  

Answer 26

status-completed

There are two 'major' changes to V1.2.2

'Remote' comment source

You can now define an external source for your comments, and 'import' them. This means that you don't have to manually copy comments from site to site and PC to PC.

To do this, you click on the 'remote' link; enter the url for your data source; then click on 'get now'.

The data source must be formatted as jsonp. There is a new 'jsonp' link in the import/export dialog which will create the appropriate jsonp from your existing comments.

It is also possible to automatically invoke it every time you open the dialog, by selecting the auto-get checkbox. I'm interested in feedback on this.

'Broadcasts'

I've added a function to be able to 'broadcast' messages without changing the code. The intended use for this will be to ask for feedback on proposed future changes. Taken this off-line again, it was not completely thought-through and you had to dismiss on every site... (sigh, no global storage)

Answer 27

status-completed (something equivalent, anyway)

I see a couple of comments here suggesting that Benjol is thinking of making the Welcome message configurable.

This is a formal request for that feature.

On Skeptics.SE, we have a meta-post which is a Welcome to New Users FAQ, and explains some of the ways Skeptics.SE differs from other Stack Exchanges. I have experimentally forked this code, just to make the Welcome message include a link to this meta-post.

Unfortunately, my JavaScript skills are too dodgy to make it customisable and offer it back to you as a patch. (The customisation strikes me as particularly tricky for the troublesome few that moderate multiple Stack Exchanges.)

---

Suggested presentation:

This is only a suggestion - incorporate it into the existing options file. It is a bit ugly, but I think better than having a whole separate config system.

~~~ This is comment text. This line represents the default.
Welcome, my dearest new friend, to $SITENAME.

~~~[skeptics] Using the same 'restriction' notations as [Q] and [A], this overrides the default for one site.
[Welcome to Skeptics](http://meta.skeptics.stackexchange.com/questions/1505/welcome-to-new-users)!

An alternative would be to put it all on one line, but then the [qualifier] notation would conflict with the [link]() notation.

Answer 28

status-completed

At the moment the Welcome message for new users is not displayed if the question was migrated from a different SE site and the user does has an account on the target site yet. The message should be inserted in this case.

Answer 29

status-completed

There should be a method to force the insertion of the Welcome message. This can be required because some new users might have and account for 2-3 weeks already but just now started to post questions or answers. They might have found SE, registered an account but then didn't return for a while. Often these people still are new to the site and a Welcome message is appropriate, especially if it got changed to include a link to a special Welcome meta page (which I did for my site TeX.SE).

Answer 30

status-completed

Can you please add a feature that allows you to type [username] (or something of the like) and the script inserts the user's name? I don't know how hard that would be, but I know you are already grabbing the user name. If at all possible, I would really appreciate this! Thanks so much for all your hard work on this script.