Skip to content

Errors FAQ

Sid Vishnoi edited this page Jul 17, 2020 · 17 revisions

Couldn't match TERM to anything in the document or in any other document cited in this specification {#term-not-found}

Screenshot of ReSpec definition  linking error

Is the term defined in some other document/specification? {#external-term-not-found}

  1. Search for the term at XRef Search UI. If the term is found:
    1. If the error message above does not contain the specification where term is defined, add the specification shortname to xref's specs. Alternatively, add the shortname as data-cite="SHORTNAME" to a parent of the <a> element with linking error.
    2. Otherwise, that means the error is due to an invalid/missing for-context (term is defined in-context of some other term) or type-context (like linking a WebIDL term using syntax for linking concepts). Copy-paste the "How to Cite" of the relevant match from XRef Search UI.
  2. If the term is not found:
    1. Try looking for similar terms. The term might not be defined exactly. Use the shorthands syntax to alias the term in prose if needed.
    2. Check if the term is exported from the other spec, i.e., the <dfn> should have a data-export attribute.
    3. If the term is not exported, ask the specification editors to export it. Feel free to ping ReSpec maintainers if you need help.
    4. If the term is exported but not found through XRef Search UI, then the specification might not be in our database. Please file an issue at ReSpec repository or contact ReSpec maintainers by other means.
      1. Terms from ECMA/IETF specifications are not presently available in the terms database. Use the data-cite attribute to reference those terms.

Is the term defined in same document? {#local-term-not-found}

  1. If it's a WebIDL term:
    1. Remember that WebIDL terms are case-sensitive, so make sure the linking text is same as definition text.
    2. Use the WebIDL linking syntax.
    3. Provide a proper for-context 1. using either data-link-for or the WebIDL linking syntax.
  2. If it's not a WebIDL term (i.e., it's a "concept"):
    1. Use the Concepts linking syntax
    2. Provide proper for-context.

Guides

Configuration options

W3C Configuration options

Linter rules

Internal properties

Handled by ReSpec for you.

Special <section> IDs

HTML elements

Custom Elements

WebIDL

HTML attributes

CSS Classes

Special properties

Clone this wiki locally