Enabling Annotations on a Spec

To add annotation capabilities to your spec, follow these steps:

Add script reference to document

Use the following script reference in the document head:

<script src="https://notes.webplatform.org/annotator.js" async defer></script>

Add metadata to document

Canonical URL

In order to make sure that all versions of the spec (different TR working drafts, Editor's Drafts, etc.) have the same annotations, we need to have a canonical URL. In most cases, this will be the spec's shortname.

Add a link element in the document head, with the attributes rel="canonical" and href with the document shortname:

<link rel="canonical" href="http://www.w3.org/TR/annotation-model/">

Notification Email Address

In order to make sure that everyone has access to the annotations, and to ensure that the annotations are archived, the annotation script needs to be able to identify the feedback link.

On the a element for the group's feedback email list address, add the attribute rel="reply-to":

<a rel="reply-to" href="mailto:public-annotation@w3.org">public-annotation@w3.org</a>

(Obviously, use the shortname and email address of your own group, not the Web Annotation WG.)

You may wish to inform readers that they can annotated the specification, with a note like the following:

Publish the spec on a supported site

Currently, the following sites are supported for annotation from Notes.WebPlatform.org:

• Specs.WebPlatform.org (and its staging server, Specs.WebPlatformStaging.org)
• w3.org/TR
• w3c.github.io