W3C home > Mailing lists > Public > spec-prod@w3.org > April to June 2019

Re: HTML and DOM LS normative and informative references

From: Marcos Caceres <w3c@marcosc.com>
Date: Tue, 25 Jun 2019 17:53:19 +1000
Cc: Dominique Hazaël-Massieux <dom@w3.org>, Michael Cooper <cooper@w3.org>, Philippe Le Hégaret <plh@w3.org>, spec-prod <spec-prod@w3.org>, Ralph Swick <swick@w3.org>
Message-Id: <64EC30E9-1247-45ED-9175-9D2B1293183D@marcosc.com>
To: Gregg Kellogg <gregg@greggkellogg.net>


> On Jun 25, 2019, at 4:58 AM, Gregg Kellogg <gregg@greggkellogg.net> wrote:
> 
> On Jun 24, 2019, at 8:03 AM, Dominique Hazael-Massieux <dom@w3.org> wrote:
>> 
>> If you use [HTML] and [DOM] (rather than e.g. [HTML5] and [DOM4]), the
>> right thing should happen.
> 
> I found that fragments within the specs were different, so if using definitions or section references, best double-check. 

Yes, excellent point Greg. We have a new tool called "respec-validator" that can check cross references for you either locally or on TravisCI [1]. You can see an example of the set up at [2] - see "install:" and "script:" sections of the .travis.yml file.

There is a little of bit of process to get the respec-validator set up on TravisCI: you need to provide an encrypted personal token from GitHub... so I'm happy to help people get that set up in their repos if needed. Please email me privately for help.
 
For DOM/HTML cross references, we are currently beta-testing a new automatic cross-referencing feature called "xref" in ReSpec. This new ReSpec feature intelligently links external terms (e.g., [=queue a task=] or {{EventTarget}} for IDL things) to the correct specification, and adds a normative or informative bibliographical reference based on the citation's context. It is backed by the same cross-referencing database that BikeShed uses.  

If all goes well, the ReSpec team will be demoing "xref" at the TPAC Tech Plenary.

[1] https://github.com/marcoscaceres/respec-validator
[2] https://github.com/w3c/html-aam/blob/gh-pages/.travis.yml#L11
Received on Tuesday, 25 June 2019 07:53:48 UTC

This archive was generated by hypermail 2.4.0 : Friday, 17 January 2020 19:55:23 UTC