no dfn in abstract - speced/respec GitHub Wiki
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