Name: display_errata
Owner: World Wide Web Consortium
Description: Using Github issues to handle errata in Recommendations
Created: 2018-01-29 12:53:52.0
Updated: 2018-01-29 12:58:25.0
Pushed: 2018-01-29 14:07:32.0
Homepage: null
Size: 22
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
This is a simple file with some associated scripts to handle Errata for published Recommendations. The “model” is as follows:
Raising and managing errata is done as follows. Note that the approach below is for a case when the errata repository is used for several recommendations (identifed by separate labels, Model and Vocab in the example below). Obviously, if a separate errata repository is used for separate documents, that approach can be simplified.
ErratumRaised?. It SHOULD also include the label corresponding to the document on which the erratum is raised, e.g., ?Model? or ?Vocab?. It is o.k. for an erratum to have several labels. In some, exceptional, cases, i.e., when the erratum is very general, it is also acceptable not to have a reference to a document.Errata? is added to the entry and the ?ErratumRaised? label should be removed. Additionally, a new comment on the issue MAY be added, beginning with the word “Summary:” (if such a summary is useful based on the discussion).That is it. When the index.html is fetched, it displays the list of accepted errata, possibly with a summary, and categorized by document. That index.html file can be used as the official errata reference in the Recommendation?s header.
The index.html file must be adapted. Apart from the obvious changes (setting the right title, reference to the Working Group, etc), the following attribute values must be set:
@data-githubrepo, to be set on the <head> element to the repository name. For W3C repositories the name is usually of the form w3c/@@@, though there are groups that use a different ?organization?.@data-erratalabel must be set on each <section> elements, except for the last one, within the <main> element. The value should be the label used in the errata repository for the specific document. The last section should be stayed as is, used by possible errata that are not explicitly assigned to a document.There are some past Working Groups that have been using the mechanism for a while, see: