localBiblio - speced/respec GitHub Wiki

localBiblio

Type: Object Default: {}

Adds custom bibliography entries that are not in the SpecRef database, or overrides existing entries for this document.

Basic usage

var respecConfig = {
  localBiblio: {
    "MY-SPEC": {
      title: "My Custom Specification",
      href: "https://example.org/my-spec/",
      status: "ED",
      publisher: "Example Community Group",
    },
  },
};

Then cite it in the document as [MY-SPEC](/speced/respec/wiki/MY-SPEC) (informative) or [!MY-SPEC](/speced/respec/wiki/!MY-SPEC) (normative).

Entry fields

Field Type Description
title string Required. The title of the referenced document
href string URL of the document
status string Publication status (e.g. "ED", "WD", "REC")
publisher string Publishing organization
authors string[] List of author names
date string Publication date
id string Identifier (if different from the key)
aliasOf string Makes this entry an alias of another reference key

Notes

  • Prefer contributing to SpecReflocalBiblio should be a last resort. Entries in SpecRef benefit all specs, not just yours.
  • To override a SpecRef entry for this document only, use the same key with your custom values
  • Keys are case-insensitive in citations ([fetch](/speced/respec/wiki/fetch) and [FETCH](/speced/respec/wiki/FETCH) refer to the same entry)