idl index - speced/respec GitHub Wiki

<section id="idl-index">

Generates a consolidated WebIDL index — all the WebIDL definitions in the spec gathered into one place, formatted as a single block.

Usage

<section id="idl-index" class="appendix">
  <!-- All WebIDL from across the document appears here -->
</section>
<section id="idl-index" class="appendix">
  <h2>Complete API Definition</h2>
  <p>The following shows the complete WebIDL for this specification.</p>
  <!-- WebIDL is inserted after the custom content -->
</section>

Excluding IDL blocks

Add class="exclude" to any <pre class="idl"> to keep it out of the IDL index — useful for non-normative illustrative examples:

<pre class="idl exclude">
  // This example IDL is not normative
  interface Example {};
</pre>

IDL blocks inside non-normative sections (class="informative") are automatically excluded.

Notes

  • Collects every normative <pre class="idl"> block in the document and combines them
  • IDL blocks with class="exclude" or inside informative sections are skipped
  • If the spec has no normative WebIDL, the section shows: "This specification doesn't normatively declare any Web IDL."
  • Add custom content (heading, intro paragraph) before the IDL — ReSpec appends the IDL after it
  • Typically placed as an informative appendix
⚠️ **GitHub.com Fallback** ⚠️