Supported Validators¶

SentenceLength¶

SentenceLength validator checks the length of sentences in the input document. If the length of the sentence is greater than the specified maximum length, the validator generates a warning.

InvalidExpression¶

InvalidExpression validator checks if input sentences contain invalid expressions (words or phrases). If the input sentence contains invalid expressions, the validator generates a warning.

like
you know
hey
kidding
what the hell
...

InvalidWord¶

InvalidWord validator checks if input sentences contain invalid words. If the input sentence contains invalid words, the validator generates a warning.

like
hey
wow
...

SpaceBeginningOfSentenceValidator¶

SpaceBeginningOfSentenceValidator validator checks if there is a white space at the end of input sentences (except for the very last sentence of paragraph). If the input sentence does end with a white space, a warning is given.

CommaNumber¶

CommaNumber validator checks the number of commas in a sentence.

WordNumber¶

WordNumber validator checks the number of words in one setnece.

SuggestExpression¶

SuggestExpression validator works in a similar way to the InvalidExpression validator. If the input sentence contains invalid expressions, this validator returns a warning suggesting the correct expression.

SVM    Support Vector Machine
LLVM   Low Level Virtual Machine
...

InvalidSymbol¶

Some symbols or characters have alternate characters with the same role. For example question mark ”? (0x003F)” has another unicode variation “？(0xFF1F)”. InvalidSymbol checks if input sentences contains invalid characters or symbols. The symbols and character settings are entered into the character setting file (char-table.xml). In this file, we write the symbols we should use in the document and their invalid counterparts. The details of these settings is described in the next section.

SymbolWithSpace¶

Some symbols need space before or after them. For example, if we want to ensure a space is added before a left parentheses “(”, we could add this preference to the character setting file (char-table.xml).

KatakanaEndHyphen¶

KatakanaEndHyphen validator checks the end hyphens of Katakana words in Japanese documents. Japanese Katakana words have variations in their end hyphen. For example, “computer” is written in Katakana as “コンピュータ” (without hyphen), and “コンピューター” (with hypen). This validator checks to ensure that Katakana words match the predefined standard. See JIS Z8301, G.6.2.2 b) G.3.

• a: Words of 3 characters or more cannot have an end hyphen.
• b: Words of 2 characters or less can have an end hyphen.
• c: A compound word should apply a and b to each component word.
• d: In the cases from a to c, the length of a syllable which is represented by a hyphen is 1 except for Youon.

KatakanaSpellCheck¶

KatakanaSpellCheck validator checks if Katakana words have very similar words with different spellings in the document. For example, if the Katakana word “インデックス” and the variation “インデクス” exist within the same document, this validator will return a warning.

SectionLength¶

SectionLength validator checks the maximum number of words allowed in an section.

ParagraphNumber¶

ParagraphNumber validator checks the maximum number of paragraphs allowed in one section.

ParagraphStartWith¶

ParagraphStartWith validator checks to see if the characters at the beginning of paragraphs conforms to the correct style.

SpaceBetweenAlphabeticalWord¶

SpaceBetweenAlphabeticalWord validator checks that alphabetic words are surrounded with whitespace. This validator is used in non-latin languages such as Japanese or Chinese.

Contraction¶

Contraction validator throws an error when contractions are used in a document in which more than half of the verbs are written in non-contracted form.

Spelling¶

Spelling validator throws an error if there are spelling mistakes in the input documents. This validator only works for English documents.

DoubledWord¶

DoubledWord validator throws an error if a word is used more than once in a sentence. For example, if an input document contains the following sentence, the validator will report an error since good is used twice.

this good item is very good.

SuccessiveWord¶

SuccessiveWord validator throws an error if the same word is used twice in succession. For example, if an input document contains the following sentence, the validator will report an error since is is used twice in succession.

the item is is very good.

DuplicatedSection¶

DuplicatedSection validator throws an error if there are section pairs which have almost the same content.

JapaneseStyle¶

JapaneseStyle validator reports errors if the input file contains both “dearu” and “desu-masu” style.

DoubleNegative¶

DoubleNegative validator reports errors when input sentence contains double negative expression.

FrequentSentenceStart¶

This validator reports an error if too many sentences start with the same sequence of words.

UnexpandedAcronym¶

This validator ensures that there are candidates for expanded versions of acronyms somewhere in the document.

That is, if there exists an acronym ABC in the document, then there must also exist a sequence of capitalized words such as Axxx Bxx Cxxx.

WordFrequency¶

This validator ensures that usage of specific words in the document don’t occur too frequently. It calculates the frequency that words are used and compares them the a reference histogram of word frequency for written English.

Excessive deviation from normal usage generates a validation error.

Hyphenation¶

This validator ensures that sequences of words that are hyphenated in the dictionary are hyphenated in your document.

NumberFormat¶

This validator ensures that numbers in a sentence are formatted using commas (ie: 12,000 instead of 120000), and don’t have excessive decimal points.

ParenthesizedSentence¶

This validator generates errors if parenthesized sentences (such as this) are used too frequently, or are nested too heavily.

WeakExpression¶

This validator generates errors if sequences of words form what is generally considered to be a “weak expression”.