SE Editor Toolkit

69

29

Looking for Maintainer

I have not had the capacity to maintain this project in any meaningful way, but the source code is quite clear and reasonably well documented. If you would be interested to maintain this project, please apply on GitHub via an issue.

This project has currently fallen so behind Stack Exchange, that it currently doesn't do anything useful. Former description follows:


There's been an onslaught of rather difficult to read questions on SO lately. A lot of them are just plain close-fodder, but many are just from d ppl ,who spk teh internetz lingo and hence make my eyes bleed are pretty much incomprehensible without extensive parsing/editing. They also somehow do not manage to grasp basic markdown. Now manually editing all these answers can often be a massive pain, so I wrote this extension.

Screenshot

It adds a few more buttons to the SE edit pages (so no distractions when just posting) that aid in making these sites awesome.

Autocorrect

This is the main tool of the suite. It is in fact a huge collection of regexps that correct the most common mistakes people commonly make on SO. These include (see the source for full details):

  • correcting capitalization (how do i do jquery. help. => How do I do jQuery. Help.)
  • correcting use of apostrophes (im cant hasnt => I'm can't hasn't)
  • correcting basic punctuation (what ? how.does......this => What? How. Does... This)
  • deleting unnecessary greetings or signs of gratitude

Note: These are Regexps, not any smart NLP so check the post so that you don't screw anything up. For that it provides:

Realtime diff

There's a handy link provided that toggles between the realtime preview and a realtime diff of your changes and the original version. All of the automated functions also automatically display the diff after execution.

Lowercasing

Sometimes people JUST CAN'T HELP SHOUTING! There's a handy button that converts selected text to lowercase, or finds sequences of shouting and lowercases them automatically.

Search & Replace

Sometimes a simple regexp can fix a lot of problems instantaneously. Click on the search button and get the Search & Replace interface:

Screenshot of Search & Replace

JS regexp support. Did I mention insta-diffing?

Code-sanetm

Sometimes people Copy-paste their code and it gets all messy. This replaces tabs with four spaces and realigns all code to the four space offset, making reformatting it a breeze. Also autoindents C-like languages to further ease the pain.

Where can I get it?

Note: I no longer have the resources to maintain the suite. I'm sure that making this a working user script would not take too much effort so pull requests with fixes are most welcome.

Gotchas

  • Autocorrect and Lowercase ignore code so be sure to mark stuff as code before you apply them.
  • Autocorrect also applies to the title of the post, be sure to check that as well.
  • Filenames sometimes get autocorrected. Mark them as code or correct them back (some common extensions are checked for, but this is by no means comprehensive. If the post is full of filenames, consider not using Autocorrect).

Version History

  • 1.1.0 released 16/3: Fixes a few bugs, adds support for C-like languages to Code-sane, adds quite a few product capitalizations and some determiner handling (an hash a apricot => a hash an apricot).

BTW does the auto-update system work?

Jakub Hampl

Posted 2011-03-15T15:36:23.553

Reputation: 801

4Will this ever be a userscript again?Cody Guldner 2013-05-27T05:16:22.717

Why are all the url here broken!!?Bibhas 2014-02-11T14:59:43.800

18+1e100 Where should I send the cash (1/2 now, 1/2 when the userscript version is available)? ;) Seriously, this should be integrated into the site software.Dennis Williamson 2011-03-15T17:25:03.337

5This is incredibly useful! +100Nathan Osman 2011-03-15T20:48:14.030

@Dori Of course not! Post them either here or at https://github.com/gampleman/SE-Editor-Toolkit/issues.

Jakub Hampl 2011-03-16T00:21:54.177

I have converted this into a UserScript, which you can find in my answer below.Nathan Osman 2011-03-16T01:24:53.950

@George Care to add it to the github repository? As the conversion looks more or less like a fairly straightforward (= automatable) process I could update both simultaneously.Jakub Hampl 2011-03-16T01:25:15.790

1@Jakub: Actually... it's not as easy as it looks. (I had to make quite a few subtle modifications.) But I'm thinking of setting something up on my server that automatically pulls the changes from GitHub and rebuilds the UserScript every so often.Nathan Osman 2011-03-16T01:28:02.433

1

@Jakub: ...and done! Every 24 hours, this file will be generated from the GitHub repos.

Nathan Osman 2011-03-16T19:15:42.270

@George Awesome! I updated the link in the post. Also thanks to Hans for helping me optimize some stuff: http://stackoverflow.com/questions/5324757/how-to-make-this-code-faster-a-question-about-regexp-performance/5325552#5325552

Jakub Hampl 2011-03-16T22:01:03.170

+∞ :) The only bad thing about this is that people that uses this will stop editing questions :/Oscar Mederos 2011-04-29T15:09:12.373

4I can't seem to get it to work on chrome, can you help?Madara Uchiha 2011-12-16T21:27:32.840

@Truth I haven't done much maintenance on this script for a while. Are you using it as a plugin or as a UserScript?Jakub Hampl 2011-12-16T22:15:22.030

as a UserScriptMadara Uchiha 2011-12-16T22:15:59.930

FWIW There's a desktop port of it that I had initially developed and works well for me https://github.com/SathyaBhat/StackEd

Sathya 2011-12-17T18:53:43.583

Would really love a working userscript version, if anyone finds the time to make it :)Emil 2013-02-15T13:27:58.483

Answers

27

Deprecated.

I'm afraid I've sort of abandoned my UserScript conversion of this extension. It was quite buggy and extremely difficult to debug. It would take less effort to write a UserScript version from scratch. – George Edison♦ Dec 20 '11 at 0:51

See new script here Stack Exchange Post Editor - Performing Basic Corrections on Posts Automatically


I quickly adapted this into a UserScript which you can get here:

http://files.quickmediasolutions.com/userscripts/edit_tools.user.js

An automated build can be obtained here:

http://quickmediasolutions.com/repos/output.user.js

The above script is automatically generated every 24 hours from the GitHub repo.

Nathan Osman

Posted 2011-03-15T15:36:23.553

Reputation: 22 100

+1e100 I see you went after the other half of the cash! See my "answer" for a bug report. I don't know if it's specific to your version or also applies to the original.Dennis Williamson 2011-03-16T01:34:27.060

1@Dennis: Please take a look at the note I added to this post.Nathan Osman 2011-03-16T19:16:08.370

In his updated original post, Jakub asks "BTW does the auto-update system work?" Is this functional in your build for the end user (e.g. me)?Dennis Williamson 2011-03-20T20:07:33.403

@Dennis: It should be. I just checked and it seems like the build script is functioning as expected.Nathan Osman 2011-03-20T20:33:39.023

So I don't need to manually update?Dennis Williamson 2011-03-20T20:37:06.453

@Dennis: Sorry, yes - you do need to update. What is meant by 'auto-update' is that the script you update from is itself updated daily directly from the source code on GitHub.Nathan Osman 2011-03-20T21:00:50.333

OK, since Jakub didn't qualify his question I though he meant that code had been added to auto-update the end-users installed copy. Sorry for the confusion.Dennis Williamson 2011-03-20T21:12:44.550

@Dennis: No problem. I understand the confusion - although an auto-update for the installed copy would be nice!Nathan Osman 2011-03-20T21:18:39.500

@Dennis the autoupdating I had in mind is a Safari feature that should automatically update the extension based on this file http://gampleman.github.com/SE-Editor-Toolkit/updates.plist

Jakub Hampl 2011-03-22T16:34:08.483

The userscript doesn't seem to work - have tried in Firefox 3.6 and 4.0...studiohack 2011-03-26T06:52:46.753

@studiohack: What errors do you get when running the script?Nathan Osman 2011-03-26T19:34:16.533

@GeorgeEdison: I don't get anything, nothing shows up at all...I've seen screenshots of what it is supposed to look like, but nothing seems to appear...I've had several other users (on SU) also say the same thing...studiohack 2011-03-26T19:41:37.463

@studiohack: It currently only works on Meta.SO.Nathan Osman 2011-03-26T20:26:49.513

oh okay @GeorgeEdison - thanks for the clarification!studiohack 2011-03-26T20:48:31.133

@George why's that?Jakub Hampl 2011-03-27T00:55:16.493

1@Jakub: I haven't had time to set that up yet. But it's planned.Nathan Osman 2011-03-27T16:43:20.160

@studio: It's working now.Nathan Osman 2011-04-06T22:43:05.323

@GeorgeEdison: doesn't seem to work...should it work on SU with FF 4? (not getting anything new in my editing interface)...studiohack 2011-04-06T23:19:52.327

@studio: Hmmm... I thought I fixed it. Give me a chance to try it on FF4 and see if I can reproduce.Nathan Osman 2011-04-06T23:23:14.790

@GeorgeEdison: take your time, no worries. Greasemonkey is somewhat buggy in FF4, my other scripts work most of the time, but not all the time..For what it's worth, I also have Ad-block installed...studiohack 2011-04-06T23:27:12.960

@studio: You are right. I can't get anything to show up in FF4 at all so it looks like it's time to do some debugging.Nathan Osman 2011-04-06T23:42:56.463

@George, @Dennis. Basic auto-update script here. I use it in the pro-forma comments script.

Benjol 2011-05-05T09:22:13.300

2As per @Sathya's bug report below, is there any chance of fixing this for inline editing? Can't get it to work on Chrome Dev.slhck 2011-08-25T10:55:15.200

@slhck: I'm not sure. I'd have to look into that.Nathan Osman 2011-08-25T16:45:08.317

14

Bug report: Inline editing breaks this :-(

Sathya

Posted 2011-03-15T15:36:23.553

Reputation: 415

8

Bug report:

Using George Edison's UserScript version. FF4.0 windows Vista - nothing shows up in the toolbar. The same installation on chrome (10.0l.648.204) is intermittent - sometimes the buttons show up and sometimes they don't.

user1150

Posted 2011-03-15T15:36:23.553

Reputation:

I can also confirm the lack of buttons using Firefox 4 on Vista.Ben Pilbrow 2011-04-03T18:47:57.240

1@Iain, @Ben: I think I have fixed both of these problems now and the script should work now.Nathan Osman 2011-04-06T03:38:33.810

@GeorgeEdison: Thanks for looking at this. Unfortunately FF 4.0 still doesn't show any auto correct button. – None – 2011-04-06T15:12:53.623

@Iain: Are any errors reported in the error console?Nathan Osman 2011-04-06T17:10:42.657

@GeorgeEdison: The only error I see is document.querySelector("#wmd-button-row") is null – None – 2011-04-06T17:34:57.173

@Iain: Then it isn't an error with my packaging.Nathan Osman 2011-04-06T18:15:43.127

Same problem here, FF 4 on Mac OS X Snow LeopardCharlesB 2011-04-13T08:21:33.943

:-( @GeorgeEdison I can't get the userscript to work in Greasemonkey on FF4.0 eitherSathya 2011-04-29T05:10:59.133

@Sathya: I know... it's quite a big disappointment. I really am having a terrible time debugging it just to find out what's going wrong.Nathan Osman 2011-04-29T05:15:19.380

@GeorgeEdison Okay :(Sathya 2011-04-30T06:34:38.460

@Sathya: Any help that anyone can provide in regards to making debugging easier would be appreciated, so hopefully someone will be able to figure out what's going on.Nathan Osman 2011-04-30T06:44:44.547

@Sathya: @GeorgeEdison: Today's 4.01 update to FF doesn't help either. – None – 2011-04-30T06:49:11.857

@GeorgeEdison - I can try to help but don't know where to start :-sSathya 2011-04-30T07:06:52.520

@GeorgeEdison Has any progress been made? Buttons still don't show up on Chrome version 16.0wizlog 2011-12-19T22:18:08.117

1@wizlog: I'm afraid I've sort of abandoned my UserScript conversion of this extension. It was quite buggy and extremely difficult to debug. It would take less effort to write a UserScript version from scratch.Nathan Osman 2011-12-20T00:51:58.043

2

I just installed the latest userscript version and I don't get a toolbar for Super User or Stack Apps. Server Fault and Stack Overflow do work. I haven't tried any others.

Dennis Williamson

Posted 2011-03-15T15:36:23.553

Reputation: 816

I just installed the latest version and I can't reproduce. What browser / OS / etc. are you using?Nathan Osman 2011-03-20T05:32:00.837

@George: Chrome (Beta) on Vista. I just tried it on Photography and Game Development. In both cases, a toolbar appeared if I tried to edit a question, but not if I tried to edit an answer.Dennis Williamson 2011-03-20T10:33:36.387

Aha! I can reproduce the problem editing answers on Photo.SE. Looking into it...Nathan Osman 2011-03-20T19:35:47.147

Seems to be a problem with the script and not my packaging, so I'll let @Jakub look into it.Nathan Osman 2011-03-20T19:40:10.137

Should be fixed in the source now, coming to a release near you soon.Jakub Hampl 2011-03-22T16:35:11.400

1

Feature request:

Make the case-change button do a three way toggle: lower, title and upper (probably in that order).

lower case
Title Case
UPPER CASE

There are occasionally legitimate needs for all caps.

Dennis Williamson

Posted 2011-03-15T15:36:23.553

Reputation: 816

Are there? Isn't usually bold face better? Also see https://github.com/gampleman/SE-Editor-Toolkit/issues#issue/1.

Jakub Hampl 2011-03-16T02:05:46.833

@Jakub: Title case definitely has its uses. All caps is useful sometimes for input data or in source code. Let's see if my suggestion gets any upvotes.Dennis Williamson 2011-03-16T02:28:51.507

2[status-completed]Jakub Hampl 2011-03-17T18:12:20.423

@Jakub: Could the tool-tip be changed to more accurately describe the new functionality?Dennis Williamson 2011-03-19T21:26:55.107

To what? Change case? Sounds kinda weird.Jakub Hampl 2011-03-19T21:41:54.920

@Jakub: I don't know why that sounds weird, but some combination of change/toggle and case/capitalization or some variation perhaps. Maybe somebody will come along with a better idea.Dennis Williamson 2011-03-19T22:13:26.813

@Dennis I'm hoping to get some proper icons for a near future release so I'll add it to that.Jakub Hampl 2011-03-19T22:44:02.613

0

Bug report:

Using George Edison's UserScript version Replace & Find doesn't update the diff, but Replace All does. I don't know if this applies to the original version or not.

Dennis Williamson

Posted 2011-03-15T15:36:23.553

Reputation: 816

3[status-completed]Jakub Hampl 2011-03-16T02:05:02.607

0

Bug Report:

It doesn't seem to work on StackApps. I don't get the added buttons in the toolbar.

As always, I'm reporting this against George's version without knowing whether it applies to the original.

In case I haven't said it already:

Thanks Jakub and George!

Dennis Williamson

Posted 2011-03-15T15:36:23.553

Reputation: 816

This is definitely a bug in my version as well, I'm just fixing it.Jakub Hampl 2011-03-16T01:51:31.777

1Done, there's a new version up.Jakub Hampl 2011-03-16T02:04:45.600

1I fixed this problem in my UserScript.Nathan Osman 2011-03-16T04:52:05.080

Also added askubuntu.com and answers.onstartups.com. Any other SE site I'm missing?Jakub Hampl 2011-03-16T19:06:51.963

@Jakub: Ya, I noticed that and added askubuntu.com to the packaging. I don't think you're missing any others.Nathan Osman 2011-03-20T19:40:48.263

0

Bug Report: (using George Edison's UserScript)

Diff ignores changes in whitespace, making indentation changes fairly invisible.

Hasturkun

Posted 2011-03-15T15:36:23.553

Reputation: 101