flaneurette/natural-grammar

There is no license information available for the latest version (dev-master) of this package.

A class to process text and auto–correct grammar

dev-master 2022-03-23 11:53 UTC

Requires

• php: >=5.6

Unknown License

README

A class to process text and auto–correct grammar following the guidelines as described in the Chicago Manual of Style. Close to artificial intelligence, it use natural language processing to correct grammar, like a human copy editor would correct a text. A thesaurus is used to beautify certain words without overdoing it. The class also compares hundreds of natural grammar fragments which I extracted and constructed from reading and editing many (news) articles and books. Any replacements made are randomized through a thesaurus, in such a way, that the text flows natural instead of being overcorrected. It does some minor auto–corrections on justifiable spelling; it only replaces that which it can safely replace, leaving room for copy editors to gloss over the text without the strain of obvious mistakes. As spellchecking is senstive to false positives, the class does not have a complete spellchecker. The class autocorrects the most common mispelled words, which consists of a list of about 200 words, acceptable for any English text.

Auto–correction includes:

   Ablaut reduplication
   Adjective ordering  (proposed)
   Anglicized words
   Character repeats
   Capitals
   Dashes
   Diagramming (proposed)
   Exaggerations (characters,values)
   Grammar fragments
   Hyperbole
   Indivisible words
   Invalid conjunctions
   Invalid comparisons
   Inaudible H
   It's vs Its
   Spelling mistakes
   Slang fragments
   Overuse of contractions
   Overuse of conjunctions "But"
   Oxford comma (replacing it)
   Punctuation
   Past tense correction
   Paragraph identation

Installing

The class can be installed via two methods, composer and manual installation.

Composer:

composer require flaneurette/natural-grammar:dev-main

Manual:

Clone or download the dev-main or package if available.

Example code:

   $run     = new grammar();
   $text    = 'We were starting to ski downhill in my 1000$ camoflage suit, like I did a million times before. Then, I chnaged my mind. "Help!!!" I said. Jane heard me. She said: "What's wrong"? Oooooooouch!!!';
   $grammar = $run->grammary($text);
   
   echo $grammar;

Example text

We were starting to ski downhill in my 1000$ camoflage suit, like I did a million times before. Then, I chnaged my mind. "Help!!!" I said. Jane heard me. She said: "What's wrong"? Oooooooouch!!!

Breakdown:

We were starting to ski downhill in my 1000 $ camoflage suit, like I did a million times before. Then, I chnaged my mind. "Help !!! " I said. Jane heard me. She said : "What's wrong" ? O oooooo ouch !! !

Corrected text:

We started to ski downhill in my $1000 camouflage suit, like I did many times before. Then, I changed my mind. "Help!" I said. Jane heard me. She said, "What's wrong?" Oouch!

License

Copyright 2019 Alexandra van den Heetkamp. This class is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version. Be sure to include the attached license when you distribute the software.