W3C Respec Followup

Paul, Irfan:

I provided incomplete information about defining termins during our last
telecon. Here's more complete info.

In the body of the document one does indeed do as I said on the call and
place the term being singled out for definition in anchor tags like
this:

<a>term</a>

The other side of the story is to create a <section> of "Key Terms" in
the document (variously placed up top or with Appendices). This section
provides the definitions using linked list markup. An example is
available here:

https://raw.githack.com/w3c/wcag/conformance-challenges-5aside/conformance-challenges/index.html#key-terms


From there respec will build the linkages.

One additional respec feature may be of use. There's specific markup for
bibliographic citations that works like this:

[[document-short-name]]

One literally drops that syntax in the document text and gets a
bibliography from respec as you can see here:

https://raw.githack.com/w3c/wcag/conformance-challenges-5aside/conformance-challenges/index.html#references


My suggestion is to do this for SSML, PLS, and any other referenced W3C
publication, including any W3C Notes, though I believe they need to have
reached formal Note status, i.e. I don't believe we can reference our
Gap Analysis this way.

FYI: The respec documentation, in case you don't have it, is worth
bookmarking and can be found here:

http://www.w3.org/respec/


CAUTION: Sometimes respec doesn't work as advertised. Caveat emptor.

Best,

Janina


-- 

Janina Sajka
https://linkedin.com/in/jsajka

Linux Foundation Fellow
Executive Chair, Accessibility Workgroup:	http://a11y.org

The World Wide Web Consortium (W3C), Web Accessibility Initiative (WAI)
Co-Chair, Accessible Platform Architectures	http://www.w3.org/wai/apa

Received on Friday, 23 April 2021 12:03:05 UTC