-
-
Notifications
You must be signed in to change notification settings - Fork 389
specStatus
Denis Ah-Kang edited this page Jun 25, 2024
·
25 revisions
Specifications can be given a status (e.g. a Working Draft, an Unofficial document, etc). However, what that status means is up to the publisher, or standards body, that is publishing the specification.
var respecConfig = {
specStatus: "unofficial",
};
Value | Meaning | Must also include |
---|---|---|
base (default) | Just the basic template, not a specification. Use this for public documentation produced by a group that has no current clear plan to be officially published. | None. |
unofficial | An unofficial draft. Use this if you're producing a document to use styles that match those of W3C specifications, for instance to propose a new document while hosting it on your own server. Note that this automatically licenses the content under CC-BY v3.0. If you want a different copyright, you will need to set the various copyright configuration options. |
|
For W3C documents, the following status are supported.
Value | Meaning | Must also include |
---|---|---|
MO | Member-Only Document. Similar to base, but for documents that need to be clearly flagged as being restricted in access to W3C Members. This is rarely, if ever, useful. | None. |
ED | Editor's Draft. Use this for documents that are maintained in the group's own repository. |
|
FPWD | First Public Working Draft. | None. |
WD | Working Draft. | |
LD | Living Document. | |
LS | Living Standard. | |
CR | Candidate Recommendation. | |
CRD | Candidate Recommendation Draft. | Same as CR above. |
PR | Proposed Recommendation. | |
PER | Proposed Edited Recommendation. | |
REC | Recommendation. | |
RSCND | Rescinded Recommendation. | |
DISC | Discontinued Draft. | |
STMT | Statement. | |
DNOTE | Draft Group Note. | None. |
NOTE | Group Note. | None. |
BG-DRAFT, BG-FINAL | Business Group Draft or Final Report. | None. |
CG-DRAFT, CG-FINAL | Community Group Draft or Final Report. | None. |
Member-SUBM | Member Submission. Note that ReSpec uses the default W3C copyright for this, but that you are entitled to retain your own copyright instead of transferring it to W3C. Use the copyright options for this. | |
draft-finding | Draft TAG Finding. If you are one of the Nine and working on a Finding, this is for you. Note that for findings, ReSpec currently does not support very robust SotD generation (there doesn't seem to be solid rules for what constitutes a valid Finding SotD) so you'll have to specify your own. If there are rules that could be used, please report a bug. ReSpec further assumes some conventions for finding URLs that are not consistent throughout all of the TAG's repository, specifically that all findings live in "https://www.w3.org/2001/tag/doc/", that the latest version is at "https://www.w3.org/2001/tag/doc/shortName", and that the dated versions are at "shortName-YYYYMMDD". | None. |
editor-draft-finding | Editor Draft TAG Finding. If you're working on a TAG document maintained on GitHub rather than in the old datedspace system, use this. | None. |
finding | TAG Finding. Same as above, but final. | None. |
💖 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