-
-
Notifications
You must be signed in to change notification settings - Fork 392
xref
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 specification shortnames. This option enables xref, but also adds the specification shortnames 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 properties
url
,specs
andprofile
.-
url
is used to link to a custom references API. -
specs
is used to specify an array of specification shortnames. This array is added to thedata-cite
attribute of the document's<body>
and used for disambiguation. -
profile
is used to specify profile.
-
Note that when using the object configuration, if both profile
and specs
properties are specified, then the specification shortnames in specs
combined with the ones in the profile used, are used for disambiguation.
Profiles are pre-defined lists of specifications. Using a profile means adding all of its specification shortnames to the data-cite
attribute of the document's <body>
.
Following profiles are currently available:
- web-platform
- Specifications included: "HTML", "INFRA", "URL", "WEBIDL", "DOM", "FETCH"
var respecConfig = {
xref: true,
};
var respecConfig = {
xref: "web-platform",
};
var respecConfig = {
xref: ["spec1", "spec2"],
};
Using the specs spec1
and spec2
along with specs in the web-platform
profile to look for references.
var respecConfig = {
xref: {
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/ ✨
- addSectionLinks
- authors
- caniuse
- edDraftURI
- editors
- favicon
- format (markdown)
- formerEditors
- github
- highlightVars
- isPreview
- license
- lint
- localBiblio
- logos
- maxTocLevel
- mdn
- modificationDate
- noTOC
- otherLinks
- pluralize
- postProcess
- preProcess
- previousDiffURI
- previousMaturity
- previousPublishDate
- prevRecShortname
- prevRecURI
-
processVersion(Deprecated) - publishDate
-
refNote(Deprecated) - shortName
- specStatus
- subjectPrefix
- subtitle
- testSuiteURI
- xref
- additionalCopyrightHolders
-
addPatentNote(Deprecated) - alternateFormats
- canonicalURI
- charterDisclosureURI
- copyrightStart
- crEnd
-
darkMode(deprecated, use dark mode) - doJsonLd
- errata
- group
- implementationReportURI
- lcEnd
- level
- noRecTrack
- prevED
- submissionCommentNumber
-
wg(Deprecated) -
wgId(Deprecated) -
wgPatentPolicy(Deprecated) -
wgPatentURI(Deprecated) - wgPublicList
-
wgURI(Deprecated)
a11y
check-punctuation
local-refs-exist
no-headingless-sections
no-http-props
no-unused-vars
no-unused-dfns
informative-dfn
privsec-section
wpt-tests-exist
Handled by ReSpec for you.
- data-abbr
-
data-cite(Not recommended) - data-dfn-for
- data-dfn-type
- data-format
- data-include-format
- data-include-replace
- data-include
- data-link-for
- data-link-type
- data-local-lt
- data-lt-no-plural
- data-lt-noDefault
- data-lt
- data-number
- data-oninclude
- data-sort
- data-tests
-
data-transform(Deprecated) - data-type
- dir
- lang