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

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

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

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