W3C home > Mailing lists > Public > spec-prod@w3.org > October to December 2020

[ReSpec] Autolink even more definitions with xref

From: Sid Vishnoi <sidvishnoi8@gmail.com>
Date: Tue, 8 Dec 2020 19:51:47 +0530
Message-ID: <CAKJqC-Q6r0nWqZZxshYAhkHyzEThyBU-A=ZaqoRS1HR2ZQYyXA@mail.gmail.com>
To: spec-prod <spec-prod@w3.org>
Hi all!

ReSpec now uses the Webref database [1] for auto linking of external
definitions (xref). Webref is more extensive and up-to-date than our
previous data source - CSSWG Shepherd. It's also easier to add new
specs to the database.

With this, you'll now be able to auto link definitions from even more
specs! Over time, the manual `<a data-cite>` will need to be used only
in exceptional cases. If you haven't used xref before, a quick
introduction can be found at
https://respec.org/docs/#referencing-terms-from-other-specifications.

Note that some of the references that were fine before might not work
anymore, as the data in Webref and Shepherd is not 100% compatible.
Please make sure to only reference the definitions that are exported
from other specifications. Contact the spec maintainers if a term you
need is not exported. Use the xref UI (https://respec.org/xref/) to
search for exported definitions, if needed.

Please report issues to the ReSpec.org repo [2], or ask for help in
#respec channel in the W3C Community Slack.

[1]: https://github.com/w3c/webref/
[2]: https://github.com/marcoscaceres/respec.org/
Relevant PR: https://github.com/sidvishnoi/respec-xref-route/pull/70

-- 
Cheers!
Sid Vishnoi
Received on Tuesday, 8 December 2020 14:22:16 UTC

This archive was generated by hypermail 2.4.0 : Tuesday, 8 December 2020 14:22:17 UTC