-
Notifications
You must be signed in to change notification settings - Fork 76
/
index.html
46 lines (40 loc) · 3.24 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>Reffy reports</title>
<link rel="stylesheet" href="https://unpkg.com/[email protected]/build/pure-min.css" integrity="sha384-nn4HPE8lTHyVtfCBi5yW9d20FjT8BJwUXyWZT9InLYax14RDjBj46LmSztkmNP9w" crossorigin="anonymous" />
<link rel="stylesheet" href="common/styles.css">
</head>
<body>
<h1>Web Platform exploration with Reffy</h1>
<p><a href="https://github.com/w3c/reffy">Reffy</a> is a <i>spec exploration tool</i>. It takes a list of specifications as input and:</p>
<ol>
<li>retrieves information about them (e.g. the URL of the latest Editor's Draft);</li>
<li>fetches and parses latest Editor's Drafts to extract WebIDL content, links and references;</li>
<li>analyses cross-spec references to report anomalies such as missing normative references, invalid or duplicated IDL terms, or links to external documents that do not appear in the list of references;</li>
<li>creates an inverse dependencies graph to list specifications that depend on a given specification;</li>
<li>generates machine-readable and human-friendly reports of previous activities.</li>
</ol>
<section>
<h2>Published reports</h2>
<p>The results of the exploration depend on the list of specifications given as input to Reffy. The following reports are available:</p>
<dl>
<dt>TR version</dt>
<dd>The crawl takes a W3C-TR-centric perspective, crawling the latest published versions of specifications in <code>/TR/</code> space instead of the latest Editor's Drafts.</dd>
<dd>See the <a href="tr/">latest TR report</a> (HTML page).</dd>
<dd>See the <a href="tr/crawl.json">results of the crawl</a> (JSON document).</dd>
<dt>Editors draft</dt>
<dd>The crawl takes a Editors-draft-centric perspective, crawling the latest editor's drafts.</dd>
<dd>See the <a href="ed/">latest Editors draft report</a> (HTML page).</dd>
<dd>See the <a href="ed/crawl.json">results of the crawl</a> (JSON document).</dd>
</dl>
<p><strong>Note:</strong> Efforts so far have focused on analysing WebIDL code. Although the list includes a few CSS and other non IDL specifications, the reports mostly contain specifications that define WebIDL content or that are directly referenced by a specification that defines WebIDL content. Reports may be extended in the future to include more specifications.</p>
</section>
<section>
<h2>About Reffy</h2>
<p>Reffy was initially created by <a href="https://github.com/tidoust/">François Daoust</a> and <a href="https://github.com/dontcallmedom/">Dominique Hazaël-Massieux</a> during the 2016 edition of the <a href="https://www.w3.org/blog/2016/07/exploring-web-platform-cross-dependencies/">W3C Geek Week</a>, and updated during the 2017 edition of that same W3C Geek Week. Code and instructions are available on <a href="https://github.com/w3c/reffy" title="Reffy repository on GitHub">GitHub</a>. Feel free to report bugs. The code is available under an <a href="https://github.com/w3c/reffy/blob/main/LICENSE">MIT license</a>.</p>
</section>
</body>
</html>