-
-
Notifications
You must be signed in to change notification settings - Fork 419
idl index
Marcos Caceres edited this page Mar 28, 2026
·
7 revisions
Generates a consolidated WebIDL index — all the WebIDL definitions in the spec gathered into one place, formatted as a single block.
<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>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.
- 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
💖 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