-
-
Notifications
You must be signed in to change notification settings - Fork 419
no dfn in abstract
Marcos Caceres edited this page Mar 28, 2026
·
1 revision
Default: false
Warns when a <dfn> element appears in <section id="abstract">, <section id="sotd">, or any other unnumbered section.
The abstract is a summary of the spec, not a definitions section. Definitions placed there are semantically out of place and appear in the terms index without section numbers.
var respecConfig = {
lint: { "no-dfn-in-abstract": true },
};<!-- BAD: dfn in the abstract -->
<section id="abstract">
<p>This spec defines the <dfn data-export>widget</dfn> API.</p>
</section>Move the definition to a numbered section:
<section id="abstract">
<p>This spec defines the Widget API.</p>
</section>
<section>
<h2>Terminology</h2>
<p>A <dfn data-export>widget</dfn> is a user interface component.</p>
</section>var respecConfig = {
lint: { "no-dfn-in-abstract": false },
};- This rule is opt-in (
falseby default) — many existing specs have dfns in their abstract - Applies to all
<dfn>elements, not just exported ones - Exported dfns in unnumbered sections cause a terms index crash in some versions of ReSpec — see bug #5133
💖 Support ReSpec by becoming a sponsor via Open Collective. 💖
✨ View rendered version of this documentation at https://respec.org/docs/ ✨
- Getting Started
- How Do I…
- Spec Editor's Guide
- Writing Algorithms
- WebIDL Guide
- Configuring ReSpec
- Developers Guide
- Shorthands
- addSectionLinks
- authors
- caniuse
- edDraftURI
- editors
- format (markdown)
- formerEditors
- github
- highlightVars
- isPreview
- license
- lint
- localBiblio
- logos
- maxTocLevel
- mdn
- modificationDate
- monetization
- noTOC
- otherLinks
- pluralize
- postProcess
- preProcess
- previousDiffURI
- previousMaturity
- previousPublishDate
- prevRecShortname
- prevRecURI
-
processVersion(Removed) - publishDate
- shortName
- specStatus
- subjectPrefix
- subtitle
- testSuiteURI
- xref
- additionalCopyrightHolders
-
addPatentNote(Removed) - alternateFormats
- canonicalURI
- charterDisclosureURI
- copyrightStart
- crEnd
- dark mode
- doJsonLd
- errata
- group
- implementationReportURI
- level
- noRecTrack
- prevED
- prEnd
- submissionCommentNumber
-
wg(Deprecated — usegroup) -
wgId(Deprecated — usegroup) -
wgPatentURI(Deprecated — usegroup) -
wgPublicList(Deprecated — usegroup) -
wgURI(Deprecated — usegroup)
a11ycheck-charsetcheck-internal-slotscheck-punctuationinformative-dfnlocal-refs-existno-captionless-tablesno-headingless-sectionsno-http-propsno-link-warningsno-unused-dfnsno-unused-varsprivsec-sectionwpt-tests-exist
Handled by ReSpec for you.
- conformance
- idl-index
- index
- issue-summary
- references
- tof (Table of Figures)
- data-abbr
- data-cite
- data-dfn-for
- data-dfn-type
- data-export
- data-format
- data-include
- data-include-format
- data-include-replace
- data-link-for
- data-link-type
- data-local-lt
- data-lt
- data-lt-no-plural
- data-lt-noDefault
- data-max-toc
- data-number
- data-oninclude
- data-sort
- data-tests
-
data-transform(Deprecated) - data-type
- dir
- lang