config.js

Naast het index.html-bestand, bevindt zich een metadata.js-bestand. Dit configuratiebestand bevat alle metadata nodig om de ReSpec weer te geven.

var respecConfig = 
{
  ...
}

De waardes in bovenstaande notatie worden hieronder beschreven.

• Datums zijn altijd in omgekeerde volgorde: JJJJ-MM-DD.
• Dit is een selectie van de configuratieopties; zie ook de documentatie van ReSpec

Veld	Waarde	Opmerkingen
subtitle	"vrije tekst"
shortName (verplicht)	"repo/doc"	naam van de repository/korte naam van het document. Is dit document de enige van de repo? Noem dan alleen doc/.
publishDate	"2022-06-21"	publicatiedatum van deze versie. Automagisch gevuld indien niet aangegeven.
Status en type
specStatus (verplicht)	"DOC", "DRAFT", "WD"	Toegestane specStatussen
specType	"vrije tekst"	Vrije tekst, documentsoort, zoals "API-documentatie", "aanbeveling"
license (verplicht)	"cc0", "cc-by", "cc-by-sa"	Kies een licentie, of geef aan met een {name, name_nl, short, url}-object
copyrightStart	"2015"
Bronvermelding
editors (verplicht)	list[Person]	Een subobject met een name is verplicht. Redacteurs zijn gebruikelijker dan auteurs. Zie respec.org#person.
authors	list[Person]	Een subobject met een name is verplicht. Redacteurs zijn gebruikelijker dan auteurs. Zie respec.org#person.
localBiblio	CITEKEY: {title, ...}	Een dict van bibliografische elementen. Zie hieronder en SpecRef.
Meedoen
github	"github-url"	verwijzing naar GitHub repo waar dit document zich bevindt. Gebruik issueBase, pullsBase als Issues en PR's afwijkend zijn.
hypothesisComments	true, false	Accepteer commentaar per Hypothes.is. Bedoeld voor bij referentieversies.
emailComments	"email-adres"	Accepteer commentaar per e-mail. Bedoeld voor bij referentieversies.
reviewDateEnd	"2023-01-01"	Datum tot wanneer reviewcommentaar ingezonden mag worden.
Levensloop
prevVersion	"volledige-url"	volledige URL van voorgaande document, zoals de consultatieversie bij een definitieve publicatie.

{
  "title": "Historie van mejuffrouw Sara Burgerhart",
  "href": "https://example.org/",
  "pages": "12-15",
  "publisher": "Isaac van Cleef",
  "date": "1777",
  "isbn": "0000-0000-0000",
  "authors": ["Betje Wolff", "Aagje Deken"],
  "etAl": false
}