data export - speced/respec GitHub Wiki

data-export / .export

Applies to: <dfn>

Marks a definition as exported — available for other specifications to cross-reference via xref. All WebIDL definitions are automatically exported; use this for prose concepts.

Usage

<p>The <dfn data-export>fetch</dfn> algorithm takes a request and returns a response.</p>

The class="export" form also works:

<dfn class="export">request</dfn>

Prevent export

<dfn data-noexport>internal algorithm</dfn>

Notes

  • Exported terms are indexed by Webref and become available in the xref database within ~6 hours of publication
  • Your spec must be listed in browser-specs to be indexed
  • Only export terms that other specifications actually need — internal helper concepts should not be exported
  • WebIDL interfaces, attributes, methods, etc. are automatically exported — you don't need data-export for IDL
  • Use data-noexport to explicitly prevent a definition from being exported (e.g. if it would shadow a same-named definition from another spec)
  • ⚠️ Do not place exported <dfn> elements in <section id="abstract"> or other unnumbered sections (SotD, introductory sections). Doing so causes a crash in the terms index (bug #5133). Define terms in a numbered section such as a "Terminology" or "Definitions" section instead.
⚠️ **GitHub.com Fallback** ⚠️