shortName

shortName

Type: string Default: undefined

The specification's short name — used in W3C TR/ URLs (e.g. https://www.w3.org/TR/short-name/) and several other generated URLs.

Basic usage

var respecConfig = {
  shortName: "payment-request",
};

Notes

• Must match exactly the short name registered with W3C for published documents
• Used to construct: the TR URL, the Editor's Draft URL (when edDraftURI is not set), and the mdn annotation key (when mdn is true)
• For Community Group reports, use the CG's assigned short name
• Short names are typically lowercase with hyphens (e.g. "fetch", "web-animations", "css-color-5")
• Before First Public Working Draft (FPWD): Setting shortName will generate a "Latest published version" link to https://www.w3.org/TR/short-name/, which will 404 until the spec is actually published. If your spec hasn't reached FPWD yet, you can either omit shortName or set latestVersion to null to suppress the link.