Skip to content
EPUBCheck · EPUBCheck configuration

EPUBCheck CHK-001: custom message file problem

Updated:

EPUBCheck CHK-001 is an error message: “The custom message overrides file was not found.” EPUBCheck could not use the custom message file passed with -c (--customMessages). CHK-001 means the file was not found, and CHK-002 to CHK-007 report other problems in it. These messages are about that file, not about the EPUB.

The official message

The custom message overrides file was not found.

Default severity
Error. The EPUB breaks a rule of the specification and is invalid. Stores and Send to Kindle may reject it, and EPUBCheck exits with status 1.
EPUBCheck version
5.4.0

Typical causes

  • CHK-001: a wrong path to the file, or a file that was moved.
  • CHK-002 and CHK-003: a message ID or a severity EPUBCheck does not recognise, from a typo or from another EPUBCheck version.
  • CHK-004 and CHK-005: a custom message or suggestion with more %1$s-style parameters than the original; CHK-006: a format parameter that cannot be parsed.
  • CHK-007: the file cannot be read or is not in the expected tab-separated format.

How to fix it

  1. Check the path you pass to -c (--customMessages) and that the file exists.
  2. To start from a correct file, run EPUBCheck with -l (--listChecks) to write the list of message IDs and their severities, then edit that list.
  3. Keep the original placeholders in custom texts and use only the severities the list shows.
  4. Or run EPUBCheck without -c to validate with the default severities.

When it's not this

CHK-008 is different: an error while processing one item of the EPUB, not the custom message file.

Also reported as

  • CHK-002 (error): Unrecognized custom message id %1$s encountered in message overrides file "%2$s".
  • CHK-003 (error): Unrecognized custom message severity "%1$s" encountered in message overrides file "%2$s".
  • CHK-004 (error): The custom message contains too many parameters in message overrides file "%1$s".
  • CHK-005 (error): The custom suggestion contains too many parameters in message overrides file "%1$s".
  • CHK-006 (error): Unable to parse the custom format parameter in message overrides file "%1$s".
  • CHK-007 (error): Error encountered while processing custom message file "%1$s": "%2$s".

Terms used here

Other CHK messages

  • CHK-008 Error encountered while processing an item "…"; skip other checks for the item.

Sources

Message text and severity from EPUBCheck 5.4.0 (W3C, BSD-3-Clause). Explanation by EpubCC.

FAQ

What does EPUBCheck CHK-001 mean?

EPUBCheck CHK-001 is an error message: “The custom message overrides file was not found.” EPUBCheck could not use the custom message file passed with -c (--customMessages). CHK-001 means the file was not found, and CHK-002 to CHK-007 report other problems in it. These messages are about that file, not about the EPUB.

Is CHK-001 an error?

CHK-001 is reported as error by default. The EPUB breaks a rule of the specification and is invalid. Stores and Send to Kindle may reject it, and EPUBCheck exits with status 1.

PDF to EPUB tools

Every tool uses the same engine and starts with a free 5-page sample.