Skip to content

xref

Jump to bottom Edit New page
Swapnil Rustagi edited this page Mar 30, 2019 · 23 revisions

The xref option allows you to configure automatic external reference linking (xref). A detailed explanation on how to use xref in specifications is given here. This page describes the various configurations available.

xref can be configured as:

var respecConfig = {
  xref: /* a valid configuration */,
};

and the following configurations are available:

  • Boolean value. Setting xref: true simply enables the xref feature.
  • Array of specifications. This option enables xref, but also adds the specifications in the array to the data-cite attribute of the document's <body>. ReSpec then uses these specifications for disambiguation.
  • Profile name (string). Specification Profiles are described below.
  • Object with the optional attributes url, specs and profile.
    1. url is used to link to a custom references databases.
    2. specs is used to specify an array of specifications. This array is added to the data-cite attribute of the document's <body> and used for disambiguation.
    3. profile is used to specify profile.

Profiles

Profiles are pre-defined lists of specifications. Using a profile means adding all of its specifications to the data-cite attribute of the document's <body>.

List of available profiles

  1. web-platform. Specifications included: HTML, INFRA, URL, WEBIDL, DOM, FETCH.

Examples

  1. Simply enable xref.
var respecConfig = {
  xref: true,
};
  1. Using the web-platform profile.
var respecConfig = {
  xref: "WEB-PLATFORM",
};
  1. Using the specs spec1 and spec2 for disambiguation.
var respecConfig = {
  xref: ["spec1", "spec2"],
};
  1. Using the specs spec1 and spec2 along with specs in the web-platform profile for disambiguation, and looking for references in the specified references database only.
var respecConfig = {
  xref: {
    url: "https://respec.org/xref", // This is also the default references database.
    specs: ["spec1", "spec2"],
    profile: "WEB-PLATFORM"
  }
};

💖 Support ReSpec by becoming a sponsor via Open Collective. 💖

✨ View rendered version of this documentation at https://respec.org/docs/ ✨

Guides

Configuration options

W3C Configuration options

Linter rules

Internal properties

Handled by ReSpec for you.

Special <section> IDs

HTML elements

Custom Elements

WebIDL

HTML attributes

CSS Classes

Special properties

Clone this wiki locally