Holistic id definition rules

w3c / wot-thing-description

Web of Things (WoT) Thing Description

http://w3c.github.io/wot-thing-description/

Other

131 stars 63 forks source link

Holistic id definition rules #2013

Open egekorkan opened 4 months ago

egekorkan commented 4 months ago

To avoid https://github.com/w3c/wot-thing-description/issues/1957 and possibly similar issues, we should be careful on the ids we choose for sections, examples, tables, figures. On one side, we can think of consistent patterns and on the other side, blacklist some.

Below are some proposals

Pattern:

Examples ex-EXAMPLENAME (these are TD snippets)
Sections sec-SECTIONNAME
Figure fig-FIGURENAME

Blacklist:

title since it is auto-generated for the document title by ReSpec

danielpeintner commented 4 months ago

As sketched having our own prefix might be a good solution. Having said that, we could also add something based on the actual document like "td-", "arch-" etc . Not sure though if this is an overkill 🙈

egekorkan commented 4 months ago

It sounds ok but we need to pay attention to assertion id policy as well