I don't think the information here needs to be particularly different from elsewhere, so I'm copying the message from the ponychan thread without the snarky introduction. So, if you've read that one, you don't have to read this.
As you may have noticed, the application has been updated. Per my discussion with Samurai Anon thanks for your input and suggestions, btw
, the background is now something approximating parchment. The review itself is now formatted differently, with each type of error spread out. Hopefully, this helps with the readability he mentioned could use improvement. The explanation section has been revamped, so it is no longer written in my best approximation of Legalese. The review output is customisable with respect to what choices you want to use.
I left the old options accessible, but that will disappear unless someone has a compelling reason for the old things to stick around.
Any suggestions regarding the new update would be greatly appreciated. I freely admit that I have absolutely no idea about graphic design, and so I'm probably committing some egregious error with my visual output and any suggestions on how to fix it would be very helpful. Also, I didn't see any when I tested it a couple times, but if anyone is getting errors, let me know and I'll try to fix it as quickly as possible.
As for what most of you don't see, here's what's going on with the code:
The main engine for the code has been completely rewritten, this time with actual documentation, so hopefully this version is readable. The link for the code is the same as the old one, https://github.com/reviewsuggestions/autoreview Thanks to Roger for posting the link in the other threadalthough I apologise to anyone who tried to look at the old thing. It's hideous!
I've also been working on getting functions and classes defined for sentence processing, which should allow the program to recognise a lot more things: short term, LUS, verb tense and agreement; later (possibly) missing/unnecessary commas. The classes are in dictclasses.py.
As a final aside that may be universally relevant, I put a module that allows the program to be used offline.
For those of you using UNIX, you put the text you want to use in a plaintext file in the same directory as the code. Then navigate to the appropriate location in terminal. For a default review, run the program with the name of your text file as an argument: ie if your text is named [code]story.txt[/code], you would type in your terminal [code]python offlineautoreview.py story.txt[/code] and the review will end up in review.html in the same directory. To change options, you put -a after the name of your story file and follow the prompts, so you would type [code]python offlineautoreview.py story.txt -a[/code] in terminal. The review will end up in the same place.
I have a hackneyed method that works for windows if you don't have python installed and in the names file, but someone else can probably give a more elegant method.
Anyway, for windows, get a version of python 2.x and put all the files in the same directory as your python files, and then using command line, navigate to that directory. Then type the same thing as above, ie [code]python offlineautoreview.py story.txt[/code] if your story is named "story.txt" for a default review, and [code]python offlineautoreview.py story.txt -a[/code] for an advanced review.
Finally, actually following the advice of Samurai, I'd like to recruit those interested in helping. For one, I have decided weaknesses in both technical and non-technical aspects necessary for continued development, so getting others on board would help mitigate those weaknesses. Also, I'm not a programmer and while I do want to see this project grow a lot more, it is ranked behind "research" in my free time activities. if research sounds vague and expansive to you, then you are right.
As a result, my development progress is very slow and often stops for long periods of time. Having others on board would both keep me accountable to keep working and allow progress even when I decide to stop working on the project for a while.
Anyone is welcome to assist, and considering that I took something like seven months just to update this, I'm not going to be a dick about any sort of deadlines. Basically, as long as you don't actively sabotage the project, you're fine.
If you want to help:
For those with programming abilities/experience:
Obviously, people interested in doing some of the coding would be very helpful. Both working on my ideas and people expanding the code base with ideas of their own. Also, even though there was a rewrite, any suggestions on how the current implementation can be improved or rewritten would be very useful.
Also, even if you don't want to write code for the project, input on how I can better collaborate would be greatly appreciated. I haven't worked a group coding project, so I'm sure I'm quite lacking in several areas. I tried to document the code well, but it wouldn't surprise me if there was some obvious thing that I forgot or didn't think to include in my documentation, so comments and criticism about how to make documentation clearer would be very helpful. Also, it probably rather obvious, but I have no idea what I'm doing with github beyond putting the code up there, so if anyone has suggestions for how I can make the stuff that is up there more accessible or better organised or improve the repository in any way, that would be very helpful.
Finally, I'm relying on security by obscurity to protect against attacks right now. For obvious reasons, I can't discuss details of this here in the open, but if you would like to try to address this, any assistance would be appreciated.
For those without or not wanting to use
As I mentioned above, I have absolutely no ability as a graphic designer, so any advice on how the site/reviews/explanations should look would be excellent. Also, suggestions on functionality or changes in wording, etc would be very helpful as well.
The next part of the project involves creating a dictionary to allow the program to recognise part of speech, conjugations, and other aspects of each word. In order to do this, I'll need to create a dictionary, which in order to be very useful, will have to be fairly large. Writing all of this, even with some automated shortcuts, would be a very long process for one person and it is also inevitable that I would make mistakes. If people would be willing to write some of the entries and/or check the entries for errors I would create a form/template that would make it simple that would speed up development and undoubtedly, keep me interested in the project a lot longer.
If you want to contact me about helping, the project, or for any other reason, you can use either the email in my trip or the one from the app (reviewsuggestions(at)gmail). They both go to the same place, so it doesn't matter which.
Thanks for reading and apologies to anyone who has been waiting for an update on this thing.
tl;dr: App updated. Opinions?
Want to help? Let me know.