-
-
Notifications
You must be signed in to change notification settings - Fork 393
person
Marcos Cáceres edited this page May 24, 2021
·
16 revisions
A person object (used for editors
, authors
) contains the following fields (most of the fields are straightforward). Only the name
field is required.
name
- Name of the person
mailto
- email address (turned into a mailto URL by respec)
url
- home page of the author
company
- company name
companyURL
- url of the company
w3cid
- identifier of the persons’ W3C account, if applicable. (This id can be found through the “my profile” URL that will be redirected to the user’s page; the id appears in the address bar).
orcid
- identifier or full URL of the persons' ORCID account.
retiredDate
- indicates the date in which an editor has retired from editing a specification. The format is yyyy-mm-dd. Additionally, if a person object is under
editors
and containsretiredDate
, it will be automatically moved toformerEditors
. note
- any text in this field will appear at the end of the person’s identification in parenthesis
extras
- refers to an array of extras (see below) objects, displayed at the end of the person's identification
The “extras” are objects, each rendered as a separate span
element, with the following fields:
name
- the content of the resulting
span
; this can contain html elements class
- a value of the class attribute added to the enclosing
span
(can be used for styling) href
- if set, the content within the enclosing
span
is turned into an active link pointing to the value ofhref
contains the following fields (most of the fields are straightforward). Only the
name
field is required.
- `name`
- Name of the person
- `url`
- home page of the author
- `company`
- company name
- `companyURL`
- url of the company
- `w3cid`
- identifier of the persons’ W3C account, if applicable. (This id can be found through the “my profile” URL that will be redirected to the user’s page; the id appears in the address bar).
- `orcid`
- identifier or full URL of the persons' ORCID account.
- `retiredDate`
- indicates the date in which an editor has retired from editing a specification. The format is yyyy-mm-dd. Additionally, if a person object is under `editors` and contains `retiredDate`, it will be automatically moved to `formerEditors`.
- `note`
- any text in this field will appear at the end of the person’s identification in parenthesis
- `extras`
- refers to an array of extras (see below) objects, displayed at the end of the person's identification
- `mailto` (**deprecated**)
- An email address. Please use url instead (e.g., `"url": "mailto:"`)
The “extras” are objects, each rendered as a separate span
element, with the
following fields:
- `name`
- the content of the resulting `span`; this can contain html elements
- `class`
- a value of the class attribute added to the enclosing `span` (can be used for styling)
- `href`
- if set, the content within the enclosing `span` is turned into an active link pointing to the value of `href`
A simple example:
{
name: "Benjamin Young",
company: "John Wiley & Sons, Inc.",
companyURL: "https://www.wiley.com/",
url: "mailto:[email protected]",
w3cid: 65468
}
A more complex example, using the extras
field to include a reference to the person’s ORCID id (with a logo):
{
name: "Ben De Meester",
company: "Ghent University - iMinds - Data Science Lab",
companyURL: "https://www.iminds.be/",
url: "https://users.ugent.be/~bjdmeest/",
retiredDate: "2020-03-26",
orcid: "0000-0003-0248-0987",
w3cid: "73403"
};
💖 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