-
-
Notifications
You must be signed in to change notification settings - Fork 402
Errors FAQ
Sid Vishnoi edited this page Jul 16, 2020
·
17 revisions
Couldn't match TERM to anything in the document or in any other document cited in this specification
- Search for the term at XRef Search UI. If the term is found:
- 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 asdata-cite="SHORTNAME"
to a parent of the<a>
element with linking error. - 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.
- If the error message above does not contain the specification where term is defined, add the specification shortname to
- If the term is not found:
- Try looking for similar terms. The term might not be defined exactly. Use the shorthands syntax to alias the term in prose if needed.
- Check if the term is exported from the other spec, i.e., the
<dfn>
should have adata-export
attribute. - If the term is not exported, ask the specification editors to export it. Feel free to ping ReSpec maintainers if you need help.
- 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.
- Terms from ECMA/IETF specifications are not presently available in the terms database. Use the
data-cite
attribute to reference those terms.
- Terms from ECMA/IETF specifications are not presently available in the terms database. Use the
- If it's a WebIDL term:
- Remember that WebIDL terms are case-sensitive, so make sure the linking text is same as definition text.
- Use the WebIDL linking syntax.
- Provide a proper for-context - using either
data-link-for
or the WebIDL linking syntax.
- If it's not a WebIDL term (i.e., it's a "concept"):
- Use the Concepts linking syntax
- Provide proper for-context.
💖 Support ReSpec by becoming a sponsor via Open Collective. 💖
✨ View rendered version of this documentation at https://respec.org/docs/ ✨
- addSectionLinks
- authors
- caniuse
- edDraftURI
- editors
- favicon
- format (markdown)
- formerEditors
- github
- highlightVars
- isPreview
- license
- lint
- localBiblio
- logos
- maxTocLevel
- mdn
- modificationDate
- noTOC
- otherLinks
- pluralize
- postProcess
- preProcess
- previousDiffURI
- previousMaturity
- previousPublishDate
- prevRecShortname
- prevRecURI
-
processVersion(Deprecated) - publishDate
-
refNote(Deprecated) - shortName
- specStatus
- subjectPrefix
- subtitle
- testSuiteURI
- xref
- additionalCopyrightHolders
-
addPatentNote(Deprecated) - alternateFormats
- canonicalURI
- charterDisclosureURI
- copyrightStart
- crEnd
-
darkMode(deprecated, use dark mode) - doJsonLd
- errata
- group
- implementationReportURI
- lcEnd
- level
- noRecTrack
- prevED
- submissionCommentNumber
-
wg(Deprecated) -
wgId(Deprecated) -
wgPatentPolicy(Deprecated) -
wgPatentURI(Deprecated) - wgPublicList
-
wgURI(Deprecated)
a11y
check-punctuation
local-refs-exist
no-headingless-sections
no-http-props
no-unused-vars
no-unused-dfns
informative-dfn
privsec-section
wpt-tests-exist
Handled by ReSpec for you.
- data-abbr
-
data-cite(Not recommended) - data-dfn-for
- data-dfn-type
- data-format
- data-include-format
- data-include-replace
- data-include
- data-link-for
- data-link-type
- data-local-lt
- data-lt-no-plural
- data-lt-noDefault
- data-lt
- data-number
- data-oninclude
- data-sort
- data-tests
-
data-transform(Deprecated) - data-type
- dir
- lang