TeXact Rules

Some of these rules can seem like nitpicking, but users are free to disable them per their liking and, if supported, configure them.

Inthis (INT)

Code

Name

Message

Severity

INT001

abstract-first-line-this-work

Avoid ‘this work’ in the first line of the abstract.

error

Casing (CAS)

Code

Name

Message

Severity

CAS001

incorrect-casing

Incorrect casing.

error

CAS002

title-casing

Use IEEE-style title casing.

error

Section (SEC)

Code

Name

Message

Severity

SEC001

heading-order

Do not skip section heading levels.

error

Math (MAT)

Code

Name

Message

Severity

MAT001

math-symbol-commands

Use LaTeX commands for plus-minus, assignment, comparison, and arrow symbols.

error

MAT002

math-operator-command

Use LaTeX commands for common math operators.

error

MAT003

textmu-command

Use \textmu instead of \mu.

error

MAT004

scaled-parentheses

Use \left and \right for math parentheses.

error

MAT005

ieee-math-environment

Use IEEEeqnarray in IEEE papers.

error

MAT006

matching-delimiters

Use matching brackets, parentheses, and braces.

error

MAT007

ellipsis-notation

Use LaTeX ellipsis commands instead of three periods.

error

MAT009

braced-math-scripts

Brace multi-character subscripts and superscripts.

warning

MAT010

braced-square-root

Brace square-root arguments.

warning

Unsure (UNS)

Code

Name

Message

Severity

UNS001

modal-or-uncertain-word

Avoid modal or uncertain wording.

error

UNS002

excessive-we-usage

Reduce use of ‘we’ when it exceeds the configured maximum.

error

UNS003

singular-author-possessive

Use authors’ to author’s in papers.

error

UNS004

space-before-punctuation

Remove spaces before punctuation.

error

UNS005

double-period-sentence

Avoid ending a sentence with two periods.

error

UNS006

space-after-period

Add a space after periods.

error

UNS007

dash-length

Use the appropriate dash for its context.

warning

UNS008

double-comma

Avoid using two commas in a row.

error

UNS009

abbreviation-punctuation

Use i.e., e.g., and et al. with correct punctuation.

error

RefLabel (REF)

Code

Name

Message

Severity

REF001

underscore-in-label

Use hyphens in label names.

error

REF002

undefined-label-reference

Undefined label.

error

REF003

unreferenced-label

Unreferenced label.

error

REF004

label-prefix

Use the matching prefix for the label context.

error

REF005

space-before-reference

Use a hard space (~) before \ref.

error

REF006

citation-before-punctuation

Place \cite{...} before punctuation.

error

REF007

label-before-caption

Put labels after captions or first numbered items.

warning

REF008

prefer-eqref

Use \eqref{...} for equation references instead of \ref.

error

REF009

parentheses-around-eqref

Remove parentheses around \eqref; it adds them automatically.

warning

REF010

capitalize-reference-type

Capitalize the first letter of reference types before \ref.

error

REF011

space-before-citation

Use a hard space (~) before \cite.

error

REF012

eqref-non-equation-label

Use \ref instead of \eqref for non-equation labels.

error

REF013

footnote-before-punctuation

Place \footnote{...} before punctuation.

error

Figure (FIG)

Code

Name

Message

Severity

FIG001

invalid-figure-position

Use an empty figure position or one of [bt], [t], [b], [tb].

error

FIG002

scaled-figure-image

Avoid scaling figure images.

error

FIG003

missing-figure-label

Add a \label{...} to the figure.

error

FIG004

missing-figure-caption

Add a \caption{...} to the figure.

error

FIG005

caption-before-graphics

Place the figure caption below the graphics.

error

FIG006

inconsistent-caption-period

Use one consistent period style for all figure captions.

error

FIG007

biography-image-not-found

Add the IEEEbiography image relative to the TeX file.

error

FIG008

invalid-biography-image-ratio

Use an IEEEbiography image with a height/width ratio of 1.25.

error

ChkTeX (CHK)

CHK001 through CHK899 are reserved for native ChkTeX diagnostics with native numbers 1 through 899. Native numbers at or above 900 are mapped into a disjoint numeric range beginning at CHK1900. Their metadata and message come from ChkTeX, and they link to the shared chktex-diagnostic page.

Code

Name

Message

Severity

CHK901

chktex-not-installed

ChkTeX not installed.

warning

CHK902

chktex-config-not-found

Provide config/chktexrc or a packaged ChkTeX configuration.

error

CHK903

chktex-command-not-found

Make the ChkTeX executable available on PATH.

error

CHK904

chktex-execution-failed

Fix the ChkTeX execution failure.

error